API文档浏览

KEMS网关和各业务模块均已集成kems-swagger,且在网关处做了文档聚合,可在线访问接口文档。

文档地址:http://[网关host]:[网关port]/doc.html

例如:http://localhost:8080/doc.html

swagger-preview

token获取

KEMS网关通过引用kems-plug-auth-webflux插件对登录策略进行扩展,下述文档将按此策略进行演示。

步骤可分为以下几步:

  • 获取随机码 随机码获取的地址为 auth/randomCode test.randomcode

  • 密码加密 使用获取到的随机码对原密码进行加密,加密方式为国密sm4

    KOCA提供加密工具,前端请搜索sm4.js,后端搜索CryptoUtils.class

  • 登录

    请求地址为http://[网关host]:[网关port]/auth/login

    请求方式为POST;

    requestbody为:

    {

    "loginName": "admin",
    "password": "tMf6XHzwgtMualcg1Ss70Q==",
    "others": {
        "appSign": "pmi",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36",
        "appLisence": "dcn70NfYC0VraWSsJ7VeylCRrNbpaMpEg/1MRMIpQwI9mavsk2TSGoJua4FxuFes",
        "authCode": "",
        "enableImgCode": false,
        "Lang": "zh-CN"
    }
    

    };

    必须保证与获取随机码请求在同一session下进行。

    获取随机码接口返回的响应头Set-Cookie中SESSION=5758b433-17e8-42e4-98e3-9e33805e534c作为登录接口中请求头Cookie的入参。

    获取随机码响应头Set-Cookie: SESSION=89af8214-8034-4528-9972-6cdca251f83f; Path=/; HttpOnly; SameSite=Lax

    登录请求头Cookie:loginName=admin; kems_loginName=admin; kems__useName=%E5%B9%B3%E5%8F%B0%E7%AE%A1%E7%90%86%E5%91%98; kems_UserId=1; SESSION=89af8214-8034-4528-9972-6cdca251f83f

test.login.username

登录成功后,可在response header中拿到token,作为接下来API调用的凭据。

test.login.token

API调用

token携带方式为Bearer Token,在请求Header中添加键值对,keyauthorizationvalueBearer+空格+登陆返回的token

Swagger方式

设置token test.swagger.set-token

接口测试 test.swagger.invoke

Postman方式

设置token

发送请求

Copyright © 2017-2023 深圳金证引擎科技有限公司 all right reserved,powered by Gitbook该文件最后修订时间: 2023-10-19 10:38:12

results matching ""

    No results matching ""