.NET Core 初次上手Swagger

安装nuget 程序包=》swashbuckle.aspnetcore

 

在  startup.configureservices  方法里添加注册生成器

 1  //注册swagger生成器，定义一个和多个swagger 文档
 2  services.addswaggergen(c =>
 3  {
 4     c.swaggerdoc("v1", new info() { title = "测试版本", version = "v1" });
 5 
 6     c.resolveconflictingactions(apidescriptions => apidescriptions.first());
 7     c.customschemaids(type => type.fullname); // 解决相同类名会报错的问题
 8 
 9     c.includexmlcomments(path.combine(directory.getcurrentdirectory(), "swaggerdemo.xml")); // 注释要使用的 xml 文档
10  });

 

 

 如果需要使用到在页面显示控制器的一些注释，可选择生成-输出-xml文档文件。

1591可免去一些没有加注释的一些警告。

注释实例：

 

----

 

 

 

在  startup.configure  方法里添加中间件服务

 //启用中间件服务生成swagger作为json终结点
app.useswagger();

//启用中间件服务对swagger-ui，指定swagger json终结点
app.useswaggerui(c =>
{
      c.swaggerendpoint("/swagger/v1/swagger.json", "demoapi v1");
 });

 

添加完后，可以自己建控制器了。

注意：控制器必须是api标识的控制器。

 

 

里面的方法也必须带有http请求协议。

 

最后执行访问=》/swagger/index.html

 

 

 

 

 学习来自依乐祝大佬的文章=》