Home

Awesome

yapi-plugin-gitlab

yapi gitlab(支持gitlab 10.0.0以上)集成插件,配置方法如下:

功能说明

  1. 提供gitlab oauth2登录

  2. 提供项目创建接口,配置gitlab的system hooks,可同步生成工程。

  3. 提供yapi与gitlab分组成员同步接口

  4. 提供yapi与gitlab项目成员同步接口

配置

第一步:在gitlab中配置oauth2, 生成appId、secret。

gitlab setting1

第二步:在gitlab中配置access-token

gitlab setting2

第三部:在gilab中配置回调函数

gitlab setting3

第四步:在生成的配置文件config.json中加入如下配置

"plugins": [{
    "name": "gitlab",
    "options": {
        "host" : "http://gitlab.example.com:port",
        "redirectUri" : "http://yapi.example.com:3000/api/plugin/oauth2/callback",
        "appId" : "xxxxxxxxxxxxxxxxxx",
        "appSecret" : "xxxxxxxxxxxxxxxxxxxxxx",
        "accessToken": "xxxxxxxxxxxxxxxxxxxxxxxx",
        "loginPath": "/api/v4/user",
        "authPath" : "/oauth/authorize",
        "tokenPath" : "/oauth/token",
        "emailKey" : "email",
        "userKey" : "username",
        "emailPostfix" : "@yapi.com"
    }
}]

配置含义如下:

效果图示

yapi login

yapi group async

yapi project async

鸣谢

xwxsee2014