yapi-plugin-gitlab2
v1.0.1
Published
devops with gitlab for yapi
Downloads
2
Readme
yapi-plugin-gitlab
yapi gitlab(支持gitlab 10.0.0以上)集成插件,配置方法如下:
功能说明
提供gitlab oauth2登录
提供项目创建接口,配置gitlab的system hooks,可同步生成工程。
提供yapi与gitlab分组成员同步接口
提供yapi与gitlab项目成员同步接口
配置
第一步:在gitlab中配置oauth2, 生成appId、secret。
第二步:在gitlab中配置access-token
第三部:在gilab中配置回调函数
第四步:在生成的配置文件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"
}
}]
配置含义如下:
host
gitlab部署地址redirectUri
oauth2回调地址appId
第一步中gitlab生成的Application IDappSecret
第一步中gitlab生成的SecretloginPath
、authPath
、tokenPath
oauth2基本配置(一般无需修改,直接复制)emailKey
gitlab用户信息邮箱关键字userKey
gitlab用户信息用户名关键字emailPostfix
如果gitlab用户没有邮箱信息在yapi中,已gitlab用户名+该后缀作为邮箱地址