如何给前端/客户端好用的接口

  1. 接口文档 一定要有!! 更新要及时、准确!!
  2. 不管返回的时候是否有值,一定要返回

    如果值为None, 尽量返回’’
    给数字类型设置默认值 -1/0
    数组为空,返回[]
    按照指定类型返回数据, 如 application/json

  3. 返回的数据格式尽量简洁

    杜绝(data的层级结构)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    {
    "name":ilearnit,
    "mobile":01010101,
    "data":
    {
    "address":Beijing
    }
    }

  4. 一个界面尽量一个接口将全部数据返回
  5. 接口自测(单元测试)