接口文档样例模板
来源：动视网
责编：小OO
时间：2025-10-02 15:38:52
接口文档样例模板
项目名称项目信息（接口模块名称）功能描述：【获取项目基本信息（整个项目信息模块的接口功能描述）】返回说明：（统一的接口返回方式）参数名称类型描述CodeString状态码：200成功404错误MsgString信息描述Data返回的数据1.获取项目基本信息（/v1/project/get）【对标题接口必须有序号，方便后期的维护和修改跟进】【接口功能描述】1.1、请求协议（https）1.2、请求方式（GET）1.3、输入参数：字段中文名英文名类型是否必填业务补充描述项目IDProject_id
导读项目名称项目信息（接口模块名称）功能描述：【获取项目基本信息（整个项目信息模块的接口功能描述）】返回说明：（统一的接口返回方式）参数名称类型描述CodeString状态码：200成功404错误MsgString信息描述Data返回的数据1.获取项目基本信息（/v1/project/get）【对标题接口必须有序号，方便后期的维护和修改跟进】【接口功能描述】1.1、请求协议（https）1.2、请求方式（GET）1.3、输入参数：字段中文名英文名类型是否必填业务补充描述项目IDProject_id
项目名称
项目信息（接口模块名称）
功能描述：
【获取项目基本信息（整个项目信息模块的接口功能描述）】
返回说明：（统一的接口返回方式）
| 参数名称 | 类型 | 描述 |
| Code | String | 状态码： 200成功 404错误 |
| Msg | String | 信息描述 |
| Data | | 返回的数据 |
1.获取项目基本信息（/v1/project/get）
【对标题接口必须有序号，方便后期的维护和修改跟进】【接口功能描述】
1.1、请求协议（https）
1.2、请求方式（GET）
1.3、输入参数：
| 字段中文名 | 英文名 | 类型 | 是否必填 | 业务补充描述 |
| 项目ID | Project_id | bigint | Y | |
1.4、返回信息：
| 字段中文名 | 英文名 | 类型 | 业务补充描述 |
| 项目ID | Id | | |
| 楼盘Code | f_house_code | | |
| 项目名 | prj_name | | |
| 标签 | prj_tags | | |
| 开发商 | developers | | |
| 销售状态 | project_sale | | |
| 经纬度 | project_location | | |
project_sale返回信息
| 字段中文名 | 英文名 | 类型 | 业务补充描述 |
| 销售状态 | sale_status | | 在售、待售、售完 |
project_location
| 字段中文名 | 英文名 | 类型 | 业务补充描述 |
| 经度 | longitude | | |
| 纬度 | latitude | | |
1.5、业务返回规则要求（业务方面的返回要求，比如查询结果按照时间排序之类的）
1、查询结果按照创建时间排序显示。。
接口文档样例模板
项目名称项目信息（接口模块名称）功能描述：【获取项目基本信息（整个项目信息模块的接口功能描述）】返回说明：（统一的接口返回方式）参数名称类型描述CodeString状态码：200成功404错误MsgString信息描述Data返回的数据1.获取项目基本信息（/v1/project/get）【对标题接口必须有序号，方便后期的维护和修改跟进】【接口功能描述】1.1、请求协议（https）1.2、请求方式（GET）1.3、输入参数：字段中文名英文名类型是否必填业务补充描述项目IDProject_id
