金色童年文档格式说明

金色童年

• 文档文件使用 Markdown 格式
• 每个文件名对应一个功能，一个功能有若干接口
• 每个接口都使用表格说明 HTTP Method 和 URL
  

  • HTTP Method 和 URL 表

  
  

  Method	Resource URL
  HTTP Method	接口路径

• 每个接口都使用表格说明参数
  

  • 参数表

  
  

  Name	Decription	Required
  参数的名字	参数的描述	是否强制

• POST、PUT、PATCH 类型的调用也给出了参数的 JSON 格式用于参考

{
    "name": "xiaoming",
    "age": 7,
}

• 三种返回数据

返回一个 JSON 数据
{
    "name": "xiaoming",
    "age": "7"
}

返回分页数据
{
    "count": 100, # 数据总计
    "next": "http://example.com/api/data/?page=3", # 下一页 url
    "previous": "http://example.com/api/data/?page=1", # 上一页 url
    "results": [{...},] # 数据集合
}

返回一个 JSON 列表
[
    {
        "name": "xiaoming"
        "avatar_url": "http://pic.example.com/xiaoming.jpg"
    },
    {
        "name": "xiaohua"
        "avatar_url": "http://pic.example.com/xiaohua.jpg"
    }
]

• 每个接口都使用表格说明返回值
  

  • 返回值表

  
  

  Name	Decription
  域(Feild)的名字	描述或说明

• 每个接口给出了 cURL 调用，用于参考

curl -X GET  -H 'Content-Type: Application/json' http://example.com/example_api/