当前位置: 首页 > 工具软件 > swagger-diff > 使用案例 >

Gitlab 生成 swagger 文档

家志学
2023-12-01

设置Gitlab CI
现在,我们需要生成并发布文档。要在Gitlab中创建CI管道,只需.gitlab-ci.yml在存储库的根目录中创建文件并添加以下代码:

image: node:latest

pages:
  stage: deploy
  script:
  - npm install -g redoc-cli
  - redoc-cli bundle -o public/index.html documentation/openapi.yaml
  artifacts:
    paths:
    - public
  only:
  - master

让我们逐行查看代码:
第1行:使用安装了最新Node.js的Docker映像(在共享运行程序上,您可以使用Docker Hub中的任何映像)
第3–4行:定义管道
第5-7行:要安装的脚本redoc-cli(生成一些美观文档的工具),然后将其全部捆绑到一个index.html文件中
第8-10行:将文件发布到Gitlab页面的路径
第11-12行:在这种情况下,将运行此管道限制为某些分支 master

引用来自

https://medium.com/hoursofoperation/auto-generate-swagger-docs-to-gitlab-pages-ca040230df3a

 类似资料: