1. 授权认证
  2. 获取用户个人信息
  3. 项目协同
  4. 代码托管
  5. 持续集成
  6. 制品仓库
  7. 测试管理
  1. 项目协同
  2. 代码仓库
  3. DevOps 实践之旅
  4. 一分钟开始持续集成之旅
  5. 持续部署
  6. 制品库

上传 API 文档

CODING 持续集成插件「读取代码生成 API 文档」可以提取代码中的注释,生成 API 文档并发布。

在代码中编写注释

在代码中编写注释,参考 OpenAPI/Swagger 编写与导入指南

并且在本地调试通过,比如 PHP Laravel Swagger 生成文档的命令是:

php artisan l5-swagger:generate
ls storage/api-docs/api-docs.json

创建空的 API 文档

在【文档管理】->【API 文档】中创建一个空的 API 文档。

使用图形化界面生成并上传 API 文档

使用【持续集成】的图形化编辑器,添加一个步骤「执行 Shell 脚本」,填入生成 API 文档的命令。

再添加一个步骤「读取代码生成 API 文档」,「语言 & 注释库」选择「其他」,填写之前生成的 json 文件路径,并且选择之前创建的「API 文档」。

Jenkinsfile

也可以使用持续集成的「文本编辑器」,填入以下代码:

pipeline {
  agent {
    docker {
      image 'sinkcup/laravel-demo:6-dev'
      args '-v /root/.composer:/root/.composer'
      reuseNode true
    }
  }
  stages {
    stage('检出') {
      steps {
        checkout([$class: 'GitSCM', branches: [[name: env.GIT_BUILD_REF]],
        userRemoteConfigs: [[url: env.GIT_REPO_URL, credentialsId: env.CREDENTIALS_ID]]])
      }
    }
    stage('安装依赖') {
      steps {
        sh 'composer install'
      }
    }
    stage('生成 API 文档') {
      steps {
        sh 'php artisan l5-swagger:generate'
        codingReleaseApiDoc(apiDocId: '1', apiDocType: 'specificFile', resultFile: 'storage/api-docs/api-docs.json')
      }
    }
  }  
}

手动或自动执行构建计划,成功后,即可通过【文档管理】->【API 文档】中的链接进行访问。

上一篇通用报告收集
最近更新
感谢反馈有用
感谢反馈没用