ASP.NET Core WebApi使用Swagger生成api说明文档

1.

2.

3.Startup.cs---ConfigureServices

  //注册Swagger生成器,定义一个和多个Swagger 文档
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info
                {
                    Version = "v1",
                    Title = "标题---哈哈哈",
                    Description = "描述---呵呵呵",
                    TermsOfService = "https://www.baidu.com/",
                    Contact = new Contact
                    {
                        Name = "张三",
                        Email = "fffffffff@qq.com",
                        Url = "https://www.baidu.com/"
                    },
                    License = new License
                    {
                        Name = "许可证名字",
                        Url = "https://www.baidu.com/"
                    }
                });
                // 为 Swagger JSON and UI设置xml文档注释路径
                var basePath = AppContext.BaseDirectory;
                var xmlPath = Path.Combine(basePath, "SwaggerDemo.xml");
                c.IncludeXmlComments(xmlPath);
            });

4.Startup.cs---Configure

          //启用中间件服务生成Swagger作为JSON终结点
            app.UseSwagger();
            //启用中间件服务对swagger-ui,指定Swagger JSON终结点
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
                //要在应用的根 (http://localhost:<port>/) 处提供 Swagger UI, RoutePrefix 属性设置为空字符串
                c.RoutePrefix = string.Empty;
            });

5.

6.

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值