NetCoreAPI添加Swagger

public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
            services.AddOptions();
            services.Configure<AppSettings>(Configuration.GetSection("AppSettings"));
            services.AddHostedService<TaskService>();
       //添加Swagger
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new  Swashbuckle.AspNetCore.Swagger.Info
                {
                    Version = "v1",
                    Title = "WebAPI",
                    //Description = "一个简单的ASP.NET Core Web API",
                    //TermsOfService = new Uri("https://www.cnblogs.com/taotaozhuanyong"),
                    //Contact = new OpenApiContact
                    //{
                    //    Name = "bingle",
                    //    Email = string.Empty,
                    //    Url = new Uri("https://www.cnblogs.com/taotaozhuanyong"),
                    //},
                    //License = new OpenApiLicense
                    //{
                    //    Name = "许可证",
                    //    Url = new Uri("https://www.cnblogs.com/taotaozhuanyong"),
                    //}
                });

                //为 Swagger JSON and UI设置xml文档注释路径
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath);
            });
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseHsts();
            }
            app.UseHttpsRedirection();
            app.UseDefaultFiles();
            app.UseMvc();
            app.UseStaticFiles();

            //启用中间件服务生成Swagger作为JSON终结点
            app.UseSwagger();
            //启用中间件服务对swagger-ui,指定Swagger JSON终结点
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
                c.RoutePrefix = string.Empty;
            });
        }
    }

原文地址:https://www.cnblogs.com/nnnnnn/p/12058484.html

时间: 2024-08-30 15:05:54

NetCoreAPI添加Swagger的相关文章

解决添加swagger后项目报错 Failed to start bean &#39;documentationPluginsBootstrapper&#39;

添加swagger后项目报错 Failed to start bean 'documentationPluginsBootstrapper' 因为swagger依赖google的guava,而当前项目的guava版本与之不匹配,将当前项目的guava版本升到swagger子依赖的guaba版本相同即可解决 原文:https://blog.csdn.net/xiaofanren1111/article/details/83011454 解决添加swagger后项目报错 Failed to star

.Net WebApi 添加Swagger

前言 随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染.先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远. 前端和后端的唯一联系,变成了API接口:API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架. 安装 首先,创建WebApi类型的项目 TestSwagger 2. 安装Swashbuckle 包和swagger.Net.UI包 3. 安装完成之后,可以看到这些类与文件都是安装完成时swag

.Net Core 添加 Swagger 支持

1. NuGet  中添加 Swashbuckle.AspNetCore 2.添加 Startup 信息 将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中: //注册Swagger生成器,定义一个和多个Swagger 文档 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "My API", Version = &quo

.net framework webapi添加swagger

1.添加引用 nuget 搜索swagger,安装Swashbuckle   (补充如果是.net core api请安装Sawshbuckle asp.net core) 2.打开项目App_Start文件夹,修改SwaggerConfig.cs配置文件 3.修改Api说明 4.创建项目xml注释文档 右键项目→属性→生成→选中下方的 "XML文档文件" 然后保存 5.配置启用: 6.启动webapi,然后在接口地址后面输入 /swagger   (默认是英文的,如果需要中文显示 

.netcore3.1添加swagger

先打开swagger官网查看文档,路径:swagger官网 那就跟着官网一步一步来吧 首先建立一个.netcore3.1的webapi,这个就不演示了. 从官网上可以看到最简单的引入swaager的步骤如下: 1.引入最新版的swaager Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4 2.在startup类中的ConfigureServices 方法中的服务集合中添加如下代码 // Register the Swagger

spring boot项目添加swagger 2.7.0(只需两步操作)

1.pom.xml引入swagger 2.7的jar包 <!-- swagger2 rest api start--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependenc

java swagger ui 添加header请求头参数

我用到的swagger 主要有三款产品,swagger editor,swagger ui 和swagger codegen. swagger editor:主要是一个本地客户端,用来自己添加api,自己来测试,相当于一个api的可视化测试工具和定义工具吧. swagger ui:主要用户嵌入到项目中,将所有的接口生成一个可视化的页面,方便前后端联调 swagger codegen:主要用于通过swagger来自动生成代码 我用的swagger ui主要在java项目中.将所有的http接口提供

netcore添加api帮助文档页-Swagger

1. 添加NuGet包 1)最基本的包:Swashbuckle.AspNetCore.Swagger 2)扩展包:Swashbuckle.AspNetCore.SwaggerGen和Swashbuckle.AspNetCore.SwaggerUI 2. Swagger是先输出xml文档,然后再从xml文档去获取api的信息的,所以需要添加文档的生成输出路径,如图 右键项目-属性-生成,勾上XML文档文件并填上对应的路径(一般默认),这个路径需要程序能访问到,需要记住!!! 注意: 1)debug

Swagger+ springfox +Spring mvc

简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步.Swagger 让部署管理和使用功能强大的API从未如此简单.这一次我将从零开始搭建一个工程来演示如何在Spring mvc中整合Swagger生成Restful接口文档. 新建工程 我们新建一个Maven工程,并添加Web Facet,工程结构如下图所