ASP.NET Core Web API 帮助页

Windos系统下使用 ASP.NET Core

系统必备

详情查看https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/first-web-api?view=aspnetcore-2.1

具有以下工作负载的 vs2017 15.7.3版或者更高版本:

  • ASP.NET 和 Web 开发
  • .NET Core 跨平台开发

 ASP.NET Core Web API 帮助页

官方Demo地址:https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/web-api-help-pages-using-swagger?view=aspnetcore-2.1

第一步:

新建项目:

第二步:

通过NuGet安装  Swashbuckle.AspNetCore

第三步:

将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中:

如果有多个Xml就需要这种形式,只有一个的话则不需要~~

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

第四步:

生成Xml文件

第五步:

加上备注,运行看效果~

但是我们运行看到的效果却是这样的~

在浏览器地址 加上后缀 /swagger就可以跳转到帮助页面,效果就出来。

为了节省时间,打开 launchSettings.json 文件,把webapi项目的启动路径设置成 swagger。这样每次调试运行项目都会自动跳转到swagger帮助页面。我们开发人员在开发项目的过程中就不用每次都要手动输入地址才能跳转到帮助页面了。

到这里已经是完成了~~

下面介绍一下,上面图中介绍到的,文档可以区分版本~

用这个标签~

[ApiExplorerSettings(GroupName = "v1")]

[ApiExplorerSettings(GroupName = "v2")]

选择v1版

选择v2版

©️2020 CSDN 皮肤主题: 精致技术 设计师:CSDN官方博客 返回首页