接口文档样例模板
合集下载
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
1、查询结果按照创建时间排序显示。。。。。
项目名称
项目信息
功能描述：
【获取项目基本信息（整个项目信息模块的接口功能描述）】
返回说明：
参数名称
类型
描述
Code
String
状态码：
200成功
404错误
Msg
String
信息描述
Data
返回的数据
1.
【对标题接口必须有序号，方便后期的维护和修改跟进】【接口功能描述】
1.1、请求协议（https）
1.2、请求方式（GET）
project_location
project_sale返回信息
字段中文名
英文名
类型
业务补充描述
销售状态
sale_status
在售、待售、售完
project_location
字段中文名
英文名
类型
业务补充描述
经度
longitude
纬度
latitude
1.5、业务返回规则要求（业务方面的返回要求，比如查询结果按照时间排序之类的）
1.3、输入参数：
字段中文名
英文名
类型
是否必填
业务补充描述
项目ID
Project_id
bigint
Y
1.4、返回信息：
字段中文名wk.baidu.com
英文名
类型
业务补充描述
项目ID
Id
楼盘Code
f_house_code
项目名
prj_name
标签
prj_tags
开发商
developers
销售状态
project_sale
经纬度
项目名称
项目信息
功能描述：
【获取项目基本信息（整个项目信息模块的接口功能描述）】
返回说明：
参数名称
类型
描述
Code
String
状态码：
200成功
404错误
Msg
String
信息描述
Data
返回的数据
1.
【对标题接口必须有序号，方便后期的维护和修改跟进】【接口功能描述】
1.1、请求协议（https）
1.2、请求方式（GET）
project_location
project_sale返回信息
字段中文名
英文名
类型
业务补充描述
销售状态
sale_status
在售、待售、售完
project_location
字段中文名
英文名
类型
业务补充描述
经度
longitude
纬度
latitude
1.5、业务返回规则要求（业务方面的返回要求，比如查询结果按照时间排序之类的）
1.3、输入参数：
字段中文名
英文名
类型
是否必填
业务补充描述
项目ID
Project_id
bigint
Y
1.4、返回信息：
字段中文名wk.baidu.com
英文名
类型
业务补充描述
项目ID
Id
楼盘Code
f_house_code
项目名
prj_name
标签
prj_tags
开发商
developers
销售状态
project_sale
经纬度