(完整版)接口文档样例模板
相关主题
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
项目名称
项目信息(接口模块名称)
功能描述:
【获取项目基本信息(整个项目信息模块的接口功能描述)】
返回说明:(统一的接口返回方式)
1.获取项目基本信息(/v1/project/get)
【对标题接口必须有序号,方便后期的维护和修改跟进】【接口功能描述】1.1、请求协议(https)
1.2、请求方式(GET)
1.3、输入参数:
1.4、返回信息:
1.5、业务返回规则要求(业务方面的返回要求,比如查询结果按照时间排序之类的)
1、查询结果按照创建时间排序显示。。。。。