接口文档样例模板

整理文档很辛苦,赏杯茶钱您下走!

免费阅读已结束,点击下载阅读编辑剩下 ...

阅读已结束,您可以下载文档离线阅读编辑

资源描述

项目名称项目信息(接口模块名称)功能描述:【获取项目基本信息(整个项目信息模块的接口功能描述)】返回说明:(统一的接口返回方式)参数名称类型描述CodeString状态码:200成功404错误MsgString信息描述Data返回的数据1.获取项目基本信息(/v1/project/get)【对标题接口必须有序号,方便后期的维护和修改跟进】【接口功能描述】1.1、请求协议(https)1.2、请求方式(GET)1.3、输入参数:字段中文名英文名类型是否必填业务补充描述项目IDProject_idbigintY1.4、返回信息:字段中文名英文名类型业务补充描述项目IDId楼盘Codef_house_code项目名prj_name标签prj_tags开发商developers销售状态project_sale经纬度project_locationproject_sale返回信息字段中文名英文名类型业务补充描述销售状态sale_status在售、待售、售完project_location字段中文名英文名类型业务补充描述经度longitude纬度latitude1.5、业务返回规则要求(业务方面的返回要求,比如查询结果按照时间排序之类的)1、查询结果按照创建时间排序显示。。。。。

1 / 3
下载文档,编辑使用

©2015-2020 m.777doc.com 三七文档.

备案号:鲁ICP备2024069028号-1 客服联系 QQ:2149211541

×
保存成功