XX社区后台API

在此可以写API整体的介绍,比如使用的技术,业务介绍,覆盖的功能范围等。 如果有共通的处理,比如说Header信息,Token,共通的Base URL等。

API分类1

API应该可以按某种方式分类,比如说和小区有关的是一类,和租客有关的是另一类,等等。

取得XX列表

这里描述此API的名称,实现什么功能,简要的介绍一下它都做了什么操作。

  • 接口地址

    1. POST: /urlpart1/urlpart2/:urlparam
  • 请求Header(没有的话可以省略)

参数名
xxx yyy
  • 请求Body
参数名 类型 是否必须 默认值 说明
xxx String 必须 租客名称
yyy Int 可选 1 租金金额

如果请求Body是JSON格式,也可以写成下面这样

  1. {
  2. "xxx": (租客名称),
  3. "yyy": (租金金额) //可选,默认值1
  4. }
  • 正常返回值
  1. {
  2. "code": "0",
  3. "userId": (user id)
  4. }
  • 异常返回值
  1. {
  2. "code": "FN01"
  3. }