【发布时间】:2020-08-12 17:38:21
【问题描述】:
Swagger UI 与 Swagger CodeGen 有什么区别?
我阅读了https://swagger.io/tools/ 中的描述。听起来 Swagger Editor、UI 和 codeGen 是完全不同的工具。如果我想生成 .Net 服务器存根并将它们可视化,是否意味着我需要同时使用 UI 和 CodeGen?
【问题讨论】:
标签: swagger swagger-ui swagger-codegen
Swagger UI 与 Swagger CodeGen 有什么区别?
我阅读了https://swagger.io/tools/ 中的描述。听起来 Swagger Editor、UI 和 codeGen 是完全不同的工具。如果我想生成 .Net 服务器存根并将它们可视化,是否意味着我需要同时使用 UI 和 CodeGen?
【问题讨论】:
标签: swagger swagger-ui swagger-codegen
是的,它们是用于不同目的的不同工具。
Swagger UI 是一个文档渲染器,基本上是一个 HTML 页面。您将它指向一个 OpenAPI 定义(YAML 或 JSON 文件),Swagger UI 会生成类似于 like this 的 API 文档。您可以将其托管在您的网站上。
Swagger Editor 是一个编辑器,您可以在其中手动编写 OpenAPI 定义,或加载/粘贴任意 OpenAPI 定义以检查它们的语法错误。 Swagger Editor 还集成了 Swagger Codegen,可通过“Generate Server”和“Generate Client”菜单访问。
Swagger Codegen 是一个代码生成器。您可以使用它从 OpenAPI 定义生成服务器存根和客户端 SDK。例如,以下是使用 Swagger Codegen CLI 生成 ASP.NET 服务器存根的方法(为便于阅读添加了换行符):
java -jar swagger-codegen-cli-3.0.21.jar generate
-i https://petstore.swagger.io/v2/swagger.yaml
-l aspnetcore
-o .\aspnetcore-server
【讨论】: