API需求设计文档范本.docx

PAGE 22 PAGE  文档状态： 核准人： 核准日期： 1.5 API 需求文档 文档历史 修订日期修订内容修订人2015.5.27圈子api需求  目录  TOC \o 1-3 \h \z \u HYPERLINK \l _Toc420497814 1 引言  PAGEREF _Toc420497814 \h 5 HYPERLINK \l _Toc420497815 1.1 编写目的  PAGEREF _Toc420497815 \h 5 HYPERLINK \l _Toc420497816 1.2 参考资料  PAGEREF _Toc420497816 \h 5 HYPERLINK \l _Toc420497817 1.3 常量定义  PAGEREF _Toc420497817 \h 5 HYPERLINK \l _Toc420497818 1.3.1 服务器地址  PAGEREF _Toc420497818 \h 5 HYPERLINK \l _Toc420497819 1.3.2 错误代码  PAGEREF _Toc420497819 \h 5 HYPERLINK \l _Toc420497820 1.3.3 性别  PAGEREF _Toc420497820 \h 5 HYPERLINK \l _Toc420497821 1.3.4 学校类型  PAGEREF _Toc420497821 \h 6 HYPERLINK \l _Toc420497822 1.3.5 用户角色  PAGEREF _Toc420497822 \h 6 HYPERLINK \l _Toc420497823 2 接口介绍  PAGEREF _Toc420497823 \h 6 HYPERLINK \l _Toc420497824 2.1 接口说明  PAGEREF _Toc420497824 \h 6 HYPERLINK \l _Toc420497825 2.2 接口协议  PAGEREF _Toc420497825 \h 6 HYPERLINK \l _Toc420497826 2.3 请求HTTP Header  PAGEREF _Toc420497826 \h 7 HYPERLINK \l _Toc420497827 2.4 请求参数  PAGEREF _Toc420497827 \h 7 HYPERLINK \l _Toc420497828 2.5 响应数据格式  PAGEREF _Toc420497828 \h 7 HYPERLINK \l _Toc420497829 2.6 身份认证  PAGEREF _Toc420497829 \h 7 HYPERLINK \l _Toc420497830 3 数据结构  PAGEREF _Toc420497830 \h 8 HYPERLINK \l _Toc420497831 3.1 基本类型定义  PAGEREF _Toc420497831 \h 8 HYPERLINK \l _Toc420497832 3.2 基本信息结构  PAGEREF _Toc420497832 \h 8 HYPERLINK \l _Toc420497833 3.2.1 图片URL信息  PAGEREF _Toc420497833 \h 8 HYPERLINK \l _Toc420497834 3.3 用户信息  PAGEREF _Toc420497834 \h 8 HYPERLINK \l _Toc420497835 3.3.1 老师用户信息  PAGEREF _Toc420497835 \h 8 HYPERLINK \l _Toc420497836 3.3.2 学生用户信息  PAGEREF _Toc420497836 \h 9 HYPERLINK \l _Toc420497837 3.4 圈子信息  PAGEREF _Toc420497837 \h 9 HYPERLINK \l _Toc420497838 3.4.1 圈子基础信息  PAGEREF _Toc420497838 \h 9 HYPERLINK \l _Toc420497839 3.4.2 圈子内容信息  PAGER