后端 API 设计
如何使用?
本 API 设计文档遵从 OpenAPI 3.0.2 标准编写,您可以跟随以下指南通过 GUI 查看其内容:
- 打开 Swagger 在线预览工具
- 将文件内容复制到编辑框,或者点击左上角 File 标签,并通过 URL 或者文件引入。
由于 Swagger Editor 本身的限制,为了达到多个 example 的目标效果,我们不得不使用非标准 OpenAPI 的语法,这可能导致编辑器报错,但并不影响显示效果,您可以通过点击 Hide 来隐藏 Errors。
本 API 设计文档遵从 OpenAPI 3.0.2 标准编写,您可以跟随以下指南通过 GUI 查看其内容:
由于 Swagger Editor 本身的限制,为了达到多个 example 的目标效果,我们不得不使用非标准 OpenAPI 的语法,这可能导致编辑器报错,但并不影响显示效果,您可以通过点击 Hide 来隐藏 Errors。