[Web API] 使用 Swagger 产生 Web API 文档以及测试站台

Swagger 用来产生文档和即时测试网站,是开发人员的小帮手,再搭配 PostMan 来产生 C# (RestClient),可以提升整体的开发速度


开发环境

  • VS 2017 15.8.4
  • Swashbuckle 5.6.0

步骤

新增一个 Web API 项目

安装套件

如果是 IIS 环境,安装  Install-Package Swashbuckle

如果是 Self-Hosted (OWIN)环境,安装  Install-Package Swashbuckle.Core

完成之后连接 /swagger,如下画面

这样就完成了,便可使用它来测试 Web API 了。

文档说明还不够,接下来,输出 XML 位置

在 SwaggerConfig.cs 反注解 c.IncludeXmlComments(GetXmlCommentsPath());

在程序内读取路径

private static string GetXmlCommentsPath()
{
 return Path.Combine(System.AppDomain.CurrentDomain.BaseDirectory, @"App_DataWebApplication1.XML");
}

注解是用三个反斜线写的

若有谬误,烦请告知,新手发帖请多包涵

2010~2017 C# 第四季