使用redoc来生成文档

    技术2022-07-15  77

    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
    Processed: 0.025, SQL: 9