yapi-plugin-pl-oauth2

第三方插件，基于 Oauth2 协议登录，在生成的配置文件中，添加如下配置即可：

"plugins": [
    {
      "name":"pl-oauth2",
      "options":{
        "userUrl":"http://sso.server.com/auth/realms/realmA/protocol/openid-connect/userinfo",
        "authUrl":"http://sso.server.com/auth/realms/realmA/protocol/openid-connect/auth",
        "tokenUrl":"http://sso.server.com/auth/realms/realmA/protocol/openid-connect/token",
        "clientId":"******",
        "clientSecret":"*******",
        "emailKey":"emailKey",
        "userKey":"userKey",
        "emailPostfix":"@yapi.com",
        "yapiHost":"yapi.server.com",
        "buttonName":"nameUwhant",
        "otherAttris":"avatar,family_name"
      }
    }
  ]

使用注意:

• Oauth2 服务器用户信息需要提供: email和username两个字段，如果字段名不一致，可以通过emailKey和userKey设置，如果没有电子邮箱字段，可以使用用户名字段+emailPostfix属性设置默认电子邮箱地址（电子邮箱是 Yapi 用户唯一标志），如果有emailKey默认使用emailKey获取邮箱信息
• sso.server.com 如果部署在容器中，注意确认容器中的网络要与 yapi.server.com 保持通畅，否则会出现 sso 登录成功，但是 yapi 显示未登录的情况

这里面的配置项含义如下：

• userUrl oauth2 服务器登录后获取用户信息访问 endpoint
• authUrl oauth2 服务器的授权 endpoint
• tokenUrl oauth2 服务器获取 token 的 endpoint
• clientId oauth2 服务器 clientId
• clientSecret oauth2 服务器 clientSecret
• emailKey 用户信息电子邮件字段 key
• userKey 用户信息用户名字段 key
• emailPostfix 邮箱后缀
• yapiHost yapi 的 Host
• buttonName yapi 首页的登录按钮显示名称
• otherAttris oauth2 服务器返回的用户属性，可同步至yapi，也可为空