接口文档样例模板.doc

《接口文档样例模板.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、项目名称项目信息（接口模块名称）功能描述：【获取项目基本信息（整个项目信息模块的接口功能描述）】返回说明：（统一的接口返回方式）参数名称类型描述CodeString状态码：200成功404错误MsgString信息描述Data返回的数据1.获取项目基本信息（/v1/project/get）【对标题接口必须有序号，方便后期的维护和修改跟进】【接口功能描述】1.1、请求协议（https）1.1、请求方式（GET）1.2、输入参数：字段中文名英文名类型是否必填业务补充描述项目IDProject_idbigintY1.3、返

2、回信息：字段中文名英文名类型业务补充描述项目IDId楼盘Codef_house_code项目名prj_name标签prj_tags开发商developers销售状态project_sale经纬度project_locationproject_sale返回信息字段中文名英文名类型业务补充描述销售状态sale_status在售、待售、售完project_location字段中文名英文名类型业务补充描述经度longitude纬度latitude1.1、业务返回规则要求（业务方面的返回要求，比如查询结果按照时间排序之类的）1

3、、查询结果按照创建时间排序显示。。。。。