接口使用说明

python python django

创建时间:2019-12-16 19:46

字数:765 阅读:

用户接口
1. 数据字典
2. 接口使用说明

用户接口

数据字典

ksuser(用户表)

COLUMN_NAME	COLUMN_TYPE	IS_NULLABLE	COLUMN_COMMENT
id	int(11)	NO
password	varchar(128)	NO	密码
last_login	datetime(6)	YES	最后登录时间
is_superuser	tinyint(1)	NO	是否超级用户
username	varchar(150)	NO	账号名称
first_name	varchar(30)	NO	名
last_name	varchar(150)	NO	姓
email	varchar(254)	NO	邮箱
is_staff	tinyint(1)	NO	是否员工
is_active	tinyint(1)	NO	是否活跃
date_joined	datetime(6)	NO	创建时间
gender	varchar(6)	NO	性别
phone	varchar(11)	YES	电话
dingding	varchar(32)	YES	钉钉账号

group(用户组)

COLUMN_NAME	COLUMN_TYPE	IS_NULLABLE	COLUMN_COMMENT
id	int(11)	NO
name	varchar(150)	NO	组名称

backendapi(后端接口)

COLUMN_NAME	COLUMN_TYPE	IS_NULLABLE	COLUMN_COMMENT
id	int(11)	NO
name	varchar(50)	YES	接口名称
pattern	varchar(100)	NO	接口正则
app_name	varchar(30)	YES	app名称
comment	varchar(100)	YES	备注

permission

COLUMN_NAME	COLUMN_TYPE	IS_NULLABLE	COLUMN_COMMENT
id	int(11)	NO
method	varchar(10)	NO	http请求方法
api_id	int(11)	NO	后端接口id

接口使用说明

一级路径： /account/

/login/

http请求方法: POST

请求体

{
 "username":"admin",
 "password":"12345678"
}

正确登录

{
  "code": 200,
  "data": {},
  "msg": "Login Successful."
}

登录错误

{
  "code": 401,
  "data": {},
  "msg": "account or password error."
}

/logout/

http请求方法: GET
请求体无

返回体

{
  "code": 204,
  "data": null,
  "msg": "请求成功"
}

/user/

http请求方法: ALL

示例

* GET 
  获取指定用户信息 /user/PK/
  获取所有用户信息 /user/

* POST
  创建用户 /user/
  批量操作 是
  请求体
  {
    "groups": [1],
    "permissions": [],
    "is_superuser": true,
    "username": "admin200",
    "first_name": "",
    "last_name": "",
    "email": "admin20@ksjgs.com",
    "is_staff": false,
    "gender": "male",
    "phone": null,
    "dingding": null,
    "password":"123456789"
  } 
  正常返回
  {
      "code": 201,
      "data": {
          "id": 33,
          "last_login": null,
          "is_superuser": true,
          "username": "admin200",
          "first_name": "",
          "last_name": "",
          "email": "admin20@ksjgs.com",
          "is_staff": false,
          "is_active": true,
          "date_joined": "2019-12-17T20:03:38.685837",
          "gender": "male",
          "phone": null,
          "dingding": null,
          "user_permissions": [],
          "permissions": [],
          "groups": [
              1
          ]
      },
      "msg": "请求成功"
  }
  请求异常返回
  {
      "code": 400,
      "data": {
          "username": [
              "A user with that username already exists."
          ]
      },
      "msg": "请求异常"
  }

* UPDATE
  全局更新用户信息 /user/PK/
  请求体
  {
 "groups": [1],
 "permissions": [],
 "is_superuser": true,
 "username": "admin20",
 "first_name": "",
 "last_name": "",
 "email": "admin20@ksjgs.com",
 "is_staff": false,
 "gender": "male",
 "phone": "138xxxx",
 "dingding": "123456789",
 "password": "12345678"
  }
  请求正常返回体同POST
  请求异常返回体同POST

* PATCH
  局部更新用户数据 /user/PK/
  请求体可以是UPDATE请求体中的任意属性

* DELETE
  删除用户 /user/PK/
  批量操作 /usr/multiple_delete/?ids=PK1,PK2,PK3

/group/

http请求方法: ALL
示例使用方法同/user/

其他接口使用说明

* 用户组批量添加用户
POST /group/PK/permission/?user_ids=user_id01,user_id02
* 用户组批量添删除用户
DELETE /group/PK/permission/?user_ids=user_id01,user_id02
* 用户组批量添加用权限
POST /group/PK/permission/?perm_ids=permission_id01,permission_id02
* 用户组批量删除权限
DELETE /group/PK/permission/?perm_ids=permission_id01,permission_id02

转载请注明来源，欢迎对文章中的引用来源进行考证，欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论，也可以邮件至 jaytp@qq.com