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

原创已于 2022-10-18 14:07:58 修改 · 1.1k 阅读

本内容遵循CC 4.0 BY-SA版权协议

标签

#.netcore

于 2022-10-17 16:12:33 首次发布

1 篇文章

订阅专栏

本文档指导如何在.NET Core项目中创建API并集成Swagger，包括去除HTTPS选项、安装Swashbuckle.AspNetCore、配置Swagger文档、显示接口信息以及添加接口注释。通过设置XML文件，Swagger可以显示接口的详细说明，简化了API文档的管理和测试。

找到ConfigureServices方法, 注册Swagger

名称和版本自行修改, 这里是默认的值

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

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

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

    c.RoutePrefix = "";
});

直接运行试试, 直接进入的就是这个页面
接下来创建一个接口控制器类

页面刷新后, 可以看到新建的已经自动更新上去
没有注释怎么办? 在你的项目根目录创建一个xml文件, 右击项目属性->生成->输出->勾选XML文件, 选择你的xml文件(因为我这里使用的VS版本不同, 找的其他博主的图顶替的, 文件名称可能不一样, 设置方法一样的)
设置后, 你在重新生成项目后, 备注就自动过去了
最后一步, 配置Swagger, 得让他知道你的文件在哪里, 依然在Setup类中, 在ConfigureServices方法里设置xml文件, 如果你的xml在根目录, 则直接打上文件名及扩展名即可
```
c.IncludeXmlComments("ApiDoc.xml", true);
```
写上备注

页面刷新一下, 会你的备注

配置很简单, 初学者不需要将配置内容单个文件去配置, 先学最简单的配置方法.