码迷,mamicode.com
首页 > 其他好文 > 详细

Core 3.0 添加Swagger文档支持

时间:2020-11-26 15:20:28      阅读:15      评论:0      收藏:0      [点我收藏+]

标签:main   注册   bin   减法   创建   nts   direct   控制器   comm   

1.创建一个Core APi项目

技术图片

 

2.引用nuget包:Swashbuckle.AspNetCore

技术图片

 

 

 3.注册中间件

 services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "Test API",
                    Description = "This Is Description",
                    Version = "v1",
                    Contact = new OpenApiContact() { Name = "Zhang San", Email = "888888888@qq.com" }
                });

                var xmlPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "CoreApi.xml");
                c.IncludeXmlComments(xmlPath);
            });

4.启用中间件

         // 启用Swagger中间件
            app.UseSwagger();
            // 配置SwaggerUI
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "Test V1");
            });

5.选择生成xml注释文档

技术图片

 

6.创建一个API控制器,添加2个简单方法

 

 [Route("api/[controller]")]
    [ApiController]
    public class TestController : ControllerBase
    {
        /// <summary>
        /// 加法运算
        /// </summary>
        /// <param name="a">第一个数</param>
        /// <param name="b">第二个数</param>
        /// <returns></returns>
        [HttpPost("Addition")]
        public int A(int a, int b)
        {
            return a + b;
        }

        /// <summary>
        /// 减法运算
        /// </summary>
        /// <param name="a">第一个数</param>
        /// <param name="b">第二个数</param>
        /// <returns></returns>
        [HttpGet("Subtraction")]
        public int B(int a, int b)
        {
            return a - b;
        }
    }

7.浏览器访问:https://localhost:端口号/swagger/index.html  

技术图片

 

 

 

 

 

 

 

Core 3.0 添加Swagger文档支持

标签:main   注册   bin   减法   创建   nts   direct   控制器   comm   

原文地址:https://www.cnblogs.com/zwlucien/p/14025096.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!