文档章节

前后端接口文档规范模板

天风霁月
 天风霁月
发布于 2018/06/28 23:35
字数 227
阅读 2062
收藏 0

[TOC]

xx系统接口V1

用户模块 user

POST 新增用户

  • URL: /V1/user

  • Request

{
  "userName":"用户名(string,50,必填)",
  "password": "密码(MD5加密,必填)",
  "account": "账号",
  "userName": "用户账号"
}
  • Response
{
  "status": "SUCCESS",
  "result":{
  	"userId": "用户ID"
  }
}

DELETE 删除用户

  • URL: /V1/user/{userId}

  • Response

{
  "status": "SUCCESS",
  "result": null
}

GET 用户列表

  • URL: /V1/user

  • Request

{
  "userName":"用户名(模糊查询)",
  "page": "当前页(不传查全部)",
  "size": "每页条数(不传查全部)"
}
  • Response
{
  "status": "SUCCESS",
  "result": {
  	"total": "总数",
	"userList": [{
      "userName":"用户名",
      "account": "账号",
      "userName": "用户账号"
    }]
  }
}

GET 查询用户详情

  • URL: /V1/user/{userId}

  • Response

{
  "status": "SUCCESS",
  "result": {
    "userName":"用户名",
    "account": "账号",
    "userName": "用户账号"
  }
}

PUT 修改用户密码

  • URL: /V1/user/{userId}/modifyPassword

  • Request

{
  "oldPassword":"旧密码",
  "newPassword": "新密码",
}

© 著作权归作者所有

天风霁月
粉丝 6
博文 8
码字总数 11571
作品 0
苏州
程序员
私信 提问

暂无文章

spring cloud Zuul API网关服务的学习(1)

在学习了spring cloud的Eureka注册服务,Ribbon客户端负载均衡,Hystrix断路器,已经声明式服务调用Feign后,我们现在理解微服务的架构如下图所示 在整个系统架构对外提供服务时,当客户端应...

太猪-YJ
9分钟前
1
0
决定分库分表的原因有哪些?

写在前面 前几天梁大发表了mysql单表500w数据分表的铁律,也参与了回复,结果同一天隔壁组面试,正好问了下面试者这个问题,面试官想在多方面考察面试者技术扎实程度,结果面试者回答的不好,...

春哥大魔王的博客
10分钟前
4
0
既然反射可以拿到私有成员变量 那private关键字有啥用?

private的意义是什么? 这个网上似乎都有标准答案了,看过之后,我总结如下: private并不是解决安全问题的,如果想让解决代码的安全问题,请用别的办法。 private的意义是OOP(面向对象编程...

Java搬砖工程师
33分钟前
1
0
【图解AI:动图】各种类型的卷积,你认全了吗?

卷积(convolution)是深度学习中非常有用的计算操作,主要用于提取图像的特征。在近几年来深度学习快速发展的过程中,卷积从标准卷积演变出了反卷积、可分离卷积、分组卷积等各种类型,以适...

雪饼
43分钟前
3
0
壮丽70年·奋斗新时代|蒸妙集团熏蒸设备的特点与功效

熏蒸仪具有显著、强大、持久的生理、药理效应。目前熏蒸仪普遍采用先进的中药汽化装置,通过数字智能化控制恒温或者电脑控温,使中药药液产生中药蒸汽。患者在薰蒸治疗时,能通过蒸汽热敷使全...

公益传承
50分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部