手把手教你ASP.NET Core：Web API文档利器Swagger

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了手把手教你ASP.NET Core：Web API文档利器Swagger，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含1014字，纯文字阅读大概需要2分钟。

内容图文

Swagger是什么？

本质上就是使用 OpenAPI 3.0 规范写一份文档，该文档描述了 API 的各种状态，你可以拿着这份文档部署在 Swagger-UI 上给对接的同事查看，也可以在 SoapUI 等工具中进行测试。

添加并配置 Swagger 中间件

需要先安装“Swashbuckle.AspNetCore”包，将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中：

services.AddSwaggerGen();

在 Startup.Configure 方法中，启用中间件为生成的 JSON 文档和 Swagger UI 提供服务：

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});

XML 注释

• 在“解决方案资源管理器”中右键单击该项目，然后选择“编辑<project_name>.csproj” 。

• 手动将PropertyGroup添加：

  true

更改services.AddSwaggerGen();代码如下：

services.AddSwaggerGen((c =>
{
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    c.IncludeXmlComments(xmlPath);
}));

演示效果

小结

现在我们终于把API文档也搞定了，再也不用傻傻的通过Word手工写API文档给前端了，而也不怕我们更新了API而文档没有同步更新。

内容总结

以上是互联网集市为您收集整理的手把手教你ASP.NET Core：Web API文档利器Swagger全部内容，希望文章能够帮你解决手把手教你ASP.NET Core：Web API文档利器Swagger所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

---