README
polygonal-auth-api
简介
该模块提供 polygonal app 后端工程的 登录验证。
配置
auth:
test: true
routePrefix: '/api/auth'
jwt:
secret: 'polygonal-default-jwt-secrect'
expires: '2h'
配置项 | 说明 | 类型 | 默认值 |
---|---|---|---|
auth.test | 是否为测试模式,如果为 true,则任意用户名密码均可登录 | boolean | false |
auth.routePrefix | 路由前缀 | 'string' | '/api/auth' |
auth.jwt.secret | JWT 密钥,请务必重新生成并并配 | 'string' | 'polygonal-default-jwt-secrect' |
auth.jwt.expires | JWT Token 有效期 | 'string' | '2h' |
使用
安装
$ yarn add polygonal-mongo-api
在 index.js 中注入插件
registrations: [
...
'polygonal-auth-api'
],
提供路由
路由 | 方法 | 参数示例 | 说明 |
---|---|---|---|
/{routePrefix}/login | POST | { username: 'zhangs', password: 'secret' } | 登录 |
/{routePrefix}/ping | GET | Ping 服务,测试 token 是否失效 |