Swagger

为API接口生成文档

Core中添加Swagger

  1. nuget安装包
install-package Swashbuckle.AspNetCore
  1. 注册服务
public void ConfigureServices(IServiceCollection services)
{
services.AddControllersWithViews(); services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo {
        Title = "My API",
        Version = "v1"
      });
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
c.IncludeXmlComments(xmlPath, true); //添加控制器层注释(true表示显示控制器注释)
});
}
  1. 使用服务

// 启用中间件为生成的 JSON 文档和 Swagger UI 提供服务
app.UseSwagger(); // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),
// specifying the Swagger JSON endpoint.
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
     //c.RoutePrefix = string.Empty;
});

 

  1. 忽略XML注释警告

右键项目属性>生成>错误和警告添加 1591

源码

最新文章

  1. 日常维护sql
  2. 解决360、猎豹浏览器等极速模式下css3兼容问题
  3. java中的传值与传引用
  4. gson 自定义对象转换格式
  5. JSON讲解和“弹窗”
  6. source insight 注册码
  7. C# 正则表达式及常用正则表达式
  8. java使用sigar 遇到问题的解决方案
  9. 解决 android.view.ViewGroup$LayoutParams cannot be cast to android.widget.AbsListView$LayoutParams
  10. Linux企业级项目实践之网络爬虫(21)——扩展为多任务爬虫
  11. 匈牙利算法(素数伴侣(HW1112))
  12. 分治算法(Divide-and-Conquer)和Google的云计算
  13. JAVA发送邮件的DEMO
  14. Luogu 1064 金明的预算方案 / CJOJ 1352 [NOIP2006] 金明的预算方案(动态规划)
  15. 获取所有栈的信息,只有最上面的和最下面的,但是不能获取栈中间的activity信息
  16. javascript两种声明函数的方式的一次深入解析
  17. Python快速学习10: 循环的对象及设计 (生活的规律)
  18. POJ 1364 / HDU 3666 【差分约束-SPFA】
  19. 普通javabean 获得项目的绝对路径
  20. 2D空间中求两圆的交点

热门文章

  1. I2C接口
  2. DOM06~
  3. win10bug可导致系统崩溃
  4. Java 8 在使用内存爆了以后会发生什么?hs_err_pid 日志如何看?
  5. 开始学python不知该怎么学?Python基础教程(第2版) 免费下载
  6. 监控系统grafana常见问题合集
  7. react修改打包后css,js,src引入的静态地址路径修改
  8. 查看nohup.out 日志文件
  9. linux批量操作(一)
  10. Linux安装Nginx安装并配置stream