如何使用.NET Web API生成Swagger 1.2 JSON

Question

我们正在尝试为我们的.NET Web API生成Swagger 1.2规范的JSON。我尝试使用Swashbuckle，但它似乎只能生成Swagger 2.0规范的JSON。

有没有人知道如何从.NET Web API（无论是否使用Swashbuckle）生成Swagger 1.2 JSON？

- quijames

Answer 1

我不确定为什么你想使用Swagger 1.2而不是Swagger 2.0，但你仍然可以使用Swashbuckle，只需使用旧版本，例如https://github.com/domaindrivendev/Swashbuckle/tree/v4.2.0。

- Ron

---

谢谢Ron。我们正在使用3Scale进行API管理，他们的文档模块需要Swagger，但不支持2.0版本。 - quijames

我相信他们很快就会添加对它的支持，而使用库从1.2迁移到2.0也不应该太困难。 - Ron

我想知道是否有一个独立的/cli解析器，可以扫描 .net 类并生成 json 文件，而无需我将包添加到项目中。 - Qiniso

很抱歉，我不熟悉这样的工具。 - Ron

Answer 2

该swagger.json文件可以通过使用Swagger作为项目构建的输出来生成。在您的WebApi .csproj文件中，请添加以下部分：

<Target Name="NSwag" AfterTargets="Build">
    <Exec Command="$(NSwagExe) webapi2swagger /infotitle:&quot;$(AssemblyName)&quot; /assembly:$(TargetPath) /output:$(OutDir)/$(AssemblyName).swagger.json" />
  </Target>

你还需要像这样归属于你的API控制器方法，例如： [SwaggerResponse(HttpStatusCode.OK，Type = typeof（object）)]

- user3558233