接口文档样例模板.docVIP

接口文档样例模板 接口文档样例模板 PAGE / NUMPAGESPAGE / NUMPAGES 接口文档样例模板 项目名称 项目信息（接口模块名称） 功能描绘： 【获得项目基本信息（整个项目信息模块的接口功能描绘） 】 返回说明：（一致的接口返回方式） 参数名称 种类 描绘 Code String 状态码： 200 成功 404 错误 Msg String 信息描绘 Data 返回的数据 1.获得项目基本信息（ /v1/project/get ） 【对标题接口一定有序号，方便后期的保护和改正跟进】 【接口功能描绘】 1.1 、 恳求协议（ https ） 1.2 、 恳求方式（ 1.3 、 输入参数：字段中文名项目 ID  GET） 英文名 种类 能否必填 业务增补描绘 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、查问结果依据创立时间排序显示。 。。。。