yapi-plugin-githubsso1

1.0.1 • Public • Published

yapi-plugin-githubsso

第三方插件,在生成的配置文件中,添加如下配置即可:

  "plugins": [
    {
      "name": "githubsso1",
      "options": {
        "type": "sso",
        "emailPostfix": "@outlook.com",
        "authorizeUri": "https://github.com/login/oauth/authorize",
        "clientId": "clientIdFromGithub",
        "clientSecret": "clientSecretIdFromGithub",
        "accessTokenUri": "https://github.com/login/oauth/access_token",
        "getUserUri": "https://api.github.com/user"
      }
    }

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

  • type 登陆类型,目前只支持sso登陆
  • loginUrl 服务端在获取token之后,可以通过这个url来获取用户的详细信息
  • clientId 登陆邮箱后缀
  • clientSecret 点击登陆按钮式需要跳转的url,用户通过该页面登录以后会向服务器发送一个token
  • authorizeUri Github暴露出来的为获取授权码的URL
  • accessTokenUri Github暴露出来的为获取Token的URL
  • getUserUri Github暴露出来的为获取用户信息的URL

Readme

Keywords

none

Package Sidebar

Install

npm i yapi-plugin-githubsso1

Weekly Downloads

1

Version

1.0.1

License

ISC

Unpacked Size

3.62 kB

Total Files

5

Last publish

Collaborators

  • nmj