文档生成（Swagger，Redoc）

文档生成（Swagger，Redoc）

为了使API易于理解，实施和维护，重要的文档。我们使用Swagger UI和Redoc（最受欢迎的API渲染工具）配置基于OpenAPI规范的自动文档生成。

这样可以让您提供一个开发的chicamintactive接口，您可以在其中研究方法结构，测试查询并快速连接到您的API。

文档中包含的内容

第 节 说明

-------------------------------	--------------------------------------------------------------
端点和方法	路由完整列表、HTTP方法、参数、标题
curl、Postman、JavaScript、Python和其他语言的脚本	查询/响应示例
授权	支持JWT, OAuth2, API Key直接来自界面
物件架构	描述模型、嵌套结构及资料需求
错误代码	所有可能的状态都有解释

我们使用的工具

Swagger UI-具有测试功能的交互式浏览器文档
Redoc是一个可读、静态的界面,非常适合在网站上发布
OpenAPI 3.0/3.1-规范格式,以构建所有内容
自动生成代码-自动注释、说明、版本和文档更新
导出到JSON/YAML/HTML

为团队和合作伙伴带来的好处

加快新开发人员的步伐
减少集成中的错误
始终是最新、与代码同步的文档
无需技术支持即可快速启动集成
在公共或私人门户网站上轻松发布文档

在哪里，特别重要

面向外部开发人员的开放API
具有主动开发的内部API
具有B2B集成和SDK的平台
需要法规和计划验证的服务

Swagger和Redoc是新一代API文档的标准。我们将配置文档的生成、更新和发布，以便任何开发人员都可以在几分钟内开始与您的API集成。