安裝准備
以下操作,默認要求自己部署過yapi,最好是部署過yapi二次開發環境。
無論是選擇在線安裝或者是本地安裝,都需要安裝client工具。
1、yapi-cli:npm install yapi-cli –g,
2、安裝后將文件夾nodejs/node_global配置進環境變量。
3、ykit: npm install -g ykit。
在線安裝
1、轉到含有config.json的目錄下
2、執行:yapi plugin --name yapi-plugin-interface-oauth2-token
在線安裝一般對網絡要求較高,在失敗的情況下可以使用離線安裝。
離線安裝
1、下載源碼:https://github.com/shouldnotappearcalm/yapi-plugin-interface-oauth2-token
2、解壓源碼中的node_modules.tar.gz
,覆蓋原來的yapi下node_modules
目錄。
3、轉到vendors目錄下
4、執行:ykit pack –m
5、若碰到以上問題,一般都需要更新node-sass,執行指令:npm rebuild node-sass
6、安裝完畢,重啟yapi服務:
配置使用
1、選擇:接口->設置->接口自動授權,選擇已設置的環境,打開自動獲取token選項,即打開計划任務:
2、獲取token地址:這里就按照一個普通接口去處理,根據不同的調用方式,填寫接口名和入參即可。有幾點說明:
a、get方法地址后帶的參數和下面的參數列表會重復,只需要填一處即可。比如上面地址里含有?username=xxx,下面的列表里就不要再寫username這個參數了。
b、“檢驗”按鈕很有用,可用判斷是否可通過當前接口取token。如果是普通接口,返回的一般是401(無授權表現),所以要保證該檢驗通過。
c、“data”表里默認是空白,旁邊有個Delete鍵。如果為空,則可以不管。不用特意按Delete鍵刪除,刪除后較難恢復。
3、設置token有效時長:短於token更新時長與token過期時長兩者的最小值即可。
4、請求頭字段:按待測程序,程序的token寫在哪里,就設置哪個字段。
5、獲取路徑:F12調試獲取token地址,如果返回的是json,那根節點就是body,然后一層層按路徑往下取即可。很多情況下路徑是這樣的:body.result.jwt.token_type + " " + body.result.jwt.access_token
6、保存:保存按鈕其實是可以起到調試作用的。保存后會實時觸發一次更新。更新后可以去“環境配置”中查看更新后的值。記得查看前要按F5刷新頁面。
至此,接口鑒權功能添加完畢。