创建OpenAPI文档可能看起来很无聊或硬。
但是，如果您仔细设计工作流程，它可能很愉快且容易。
在本文中，我将解释如何在Woovi创建OpenAPI文档。
代码和文档的托管
我们在设计此工作流程时认为的第一件事是，除了代码外，还应将文档进行统计。
如果您检查上图，则GET /CHARGE API除了chargeGet.yml Documentation File。< /p>
写一些YML
/api/v1/charge/{id}:
get:
tags:
- charge
summary: Get one charge
parameters:
- name: id
in: path
responses:
'200':
description: The charge retrieve using the given ID
content:
application/json:
schema:
...
我们使用YML格式编写文档。我们描述了端点，标签，组件，枚举以及API文档所需的所有内容。
捆绑YML文件
OpenAPI编辑器不接受许多文件，他们只接受1个单个YML或JSON文件。因此，我们需要找到一种将所有单独的YML文档捆绑到一个单个文档的方法。
对于此任务，我们将使用swagger-jscode。它说是在jsdoc内写下swagger，旧名称的openapi，如下
/**
* @openapi
* /:
* get:
* description: Welcome to swagger-jsdoc!
* responses:
* 200:
* description: Returns a mysterious string.
*/
app.get('/', (req, res) => {
res.send('Hello World!');
});
这听起来像是一个好主意，但是如果您的文档太大，则不会扩展。幸运的是，此软件包还包装.yml文件。
这是我们用来捆绑文档的命令行调用
yarn swagger-jsdoc -d wooviConfig.js src/charge/**.yml -o woovi-openapi.yml
此命令生成一个最终的woovi-openapi.yml，其中包含所有.yml文件的内容。
结束
当您投资DX时，当您使某些事情变得容易时，每个人都会开始这样做。
文档不应该是痛苦，文档应该是我们工作流程的一部分。
文档是通信。
woi
Woovi是一家创业公司，使购物者能够按照自己的意愿付款。为了实现这一目标，Woovi为商人提供即时付款解决方案接受订单。
如果您想与我们合作，我们是hiring！