Gitlab 生成 swagger 文档

设置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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值