.NET Core Api使用Swagger自动生成接口页面

1. 创建Api项目
   
   下一步->选择Core 并去掉Https的勾选项
   
   下一步, 创建成功
2. 打开项目包管理, 搜索Swashbuckle.AspNetCore并安装
   
3. 配置Swagger, 这里我们直接在一个文件中搞定, 打开Setup类
   
4. 找到ConfigureServices方法, 注册Swagger
   
   名称和版本自行修改, 这里是默认的值

   services.AddSwaggerGen(c =>
   {
       c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
   });

5. 同样在Setup类中找到Configure方法, 同样输入如下代码段, 注意路径中的v1必须与上图中的v1名称及大小写一致
   
    

   app.UseSwagger();
   app.UseSwaggerUI(c =>
   {
       c.SwaggerEndpoint("/swagger/v1/swagger.json", ".NET Core Api V1");
   
       c.RoutePrefix = "";
   });
   

6. 直接运行试试, 直接进入的就是这个页面
   

    

7. 接下来创建一个接口控制器类
   

   页面刷新后, 可以看到新建的已经自动更新上去 

   

8. 没有注释怎么办? 在你的项目根目录创建一个xml文件, 右击项目属性->生成->输出->勾选XML文件, 选择你的xml文件(因为我这里使用的VS版本不同, 找的其他博主的图顶替的, 文件名称可能不一样, 设置方法一样的)
   
   

9. 设置后, 你在重新生成项目后, 备注就自动过去了
   

10. 最后一步, 配置Swagger, 得让他知道你的文件在哪里, 依然在Setup类中, 在ConfigureServices方法里设置xml文件, 如果你的xml在根目录, 则直接打上文件名及扩展名即可
    
     

    c.IncludeXmlComments("ApiDoc.xml", true);

11. 写上备注
    

    页面刷新一下, 会你的备注
    
    
    
    
    配置很简单, 初学者不需要将配置内容单个文件去配置, 先学最简单的配置方法.