使用redoc来生成文档
redoc只需要一个.yaml就可以生成一个很漂亮的文档。https://github.com/Redocly/redoc这是一个写接口文档的神器，里面的格式可以参照openapi3.0来写。根据https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md知道它的结构了可以点目录速查比如你现在写了一个opena
文章共132字 · 阅读需要大约1分钟
一键AI生成摘要，助你高效阅读
问答
·
redoc只需要一个.yaml就可以生成一个很漂亮的文档。
https://github.com/Redocly/redoc 这是一个写接口文档的神器，里面的格式可以参照openapi3.0来写。
根据https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md 知道它的结构了可以点目录速查
比如你现在写了一个openapi.yaml的文档
安装 redoc-cli
npm i -g redoc-cli
执行如下命令就可以启动服务，生成文档了。
redoc-cli serve openapi.yaml
旨在为数千万中国开发者提供一个无缝且高效的云端环境，以支持学习、使用和贡献开源项目。
更多推荐
0
0- 0
已为社区贡献3条内容
所有评论(0)