用 Swagger 记录 API
Documenting API with Swagger
我是 Swagger 的新手。我有一个 API,我想用基于模型的 Swagger 记录它,而不是基于注释。请提供一些指导我该怎么做?提前致谢!我需要文献、示例、教程等。
Swagger 是为您的 API 创建 REST API 文档和沙盒的最简单方法,您只需遵循 swagger API 定义的一些注释规则即可。
你必须先学习以下内容-
- 基本 REST API 概念
- 休息 API 玩。
- 查看 Swagger 注释。
您可以在 http://petstore.swagger.io/
查看演示
要了解流程,请参阅以下文件
https://github.com/swagger-api/swagger-play-sample-app/blob/master/conf/routes
我是 Swagger 的新手。我有一个 API,我想用基于模型的 Swagger 记录它,而不是基于注释。请提供一些指导我该怎么做?提前致谢!我需要文献、示例、教程等。
Swagger 是为您的 API 创建 REST API 文档和沙盒的最简单方法,您只需遵循 swagger API 定义的一些注释规则即可。
你必须先学习以下内容-
- 基本 REST API 概念
- 休息 API 玩。
- 查看 Swagger 注释。
您可以在 http://petstore.swagger.io/
查看演示要了解流程,请参阅以下文件
https://github.com/swagger-api/swagger-play-sample-app/blob/master/conf/routes