yapi-plugin-yachsso

yapi集成Yach通用组件SSO插件

使用

第一步： 在通用组件申请一个应用，

申请应用的表单内，单点登录回调地址示意如下：

https://yapi.xxxx.com/api/user/login_by_token

第二步： 在yapi生成的配置文件config.json中加入如下配置：

"plugins": [
    {
      "name": "yachsso", 
      "options": {
        "type": "sso", // 登陆类型，目前只支持sso登陆
        "appid": "",    // 申请的应用id
        "appkey": "",   // 申请的应用key
        "ssoLoginUrl": "https://sso.100tal.com/portal/login", // 点击登录按钮需要跳转的SSO域名
        "ssoApiUrl" : "https://api.service.100tal.com",  // SSO扫码后的验证接口域名     
        "mode" : "mixin" // 只保留SSO登录，还是和Yapi原登录共存。mixin(共存，默认)、along(只保留SSO登录)
      }
    }
]

注意，mode为along时，请使用基于官方yapi二次开发的yach内部版本.

第三步：在config.json 这层目录下安装插件

$ yapi plugin --name yapi-plugin-yachsso #下载插件

• 如果提示需要安装ykit，则执行下

$ yarn global add ykit

• 如果yachsso插件安装失败，则手动安装并编译插件

$ cd vendors
$ yarn add yapi-plugin-yachsso
$ ykit pack -m # 因为涉及到react模板 所以需要pack  如果只是改server.js 则无需pack

第四步： 重启服务器

$ pm2 restart server/app.js

发布日志

2.1.1

2020-07-12

• 🌟 调整跳转逻辑

2.0.2

2020-07-12

• 🌟 server增加参数mode、ssoLogoutUrl

2.0.1

2020-07-12

• 🐞 修复along模式跳转错误

2.0.0

2020-07-11

• 🆕 增加mode参数：mixin、along。分别代表和原登录共存、替换原登录
• 🆕 考虑语义化，参数调整，不兼容1.x