polygonal-user-api

user api used by polygonal app

Usage no npm install needed!

<script type="module">
  import polygonalUserApi from 'https://cdn.skypack.dev/polygonal-user-api';
</script>

README

polygonal-user-api

简介

该模块提供 polygonal app 后端工程的 用户管理。

配置

user:
  routePrefix: '/api/users',

配置项	说明	类型	默认值
auth.routePrefix	路由前缀	'string'	'/api/user'

使用

安装

$ yarn add polygonal-user-api

在 index.js 中注入插件

registrations: [
  'polygonal-user-api'
],

提供路由

路由	方法	参数示例	说明
/api/my	GET		获取个人信息
/api/my	PUT	{ username: 'zhangs', nickname: '张三' }	更新个人信息
/{routePrefix}	GET		获取用户列表
/{routePrefix}/{_id}	GET		获取用户信息
/{routePrefix}	POST	{ username: 'zhangs', nickname: '张三' }	创建用户
/{routePrefix}/{_id}	PUT	{ username: 'zhangs', nickname: '张三' }	更新用户信息
/{routePrefix}/{_id}	DELETE		删除用户