接口文档模板参考

2019独角兽企业重金招聘Python工程师标准>>>

一、接口名称

列表查询接口

二、接口详情

1、提供首页数据显示

2、提供首页数据查询

三、接口地址

1、本地开发环境：http://localhost:8080/test/index/list.json

2、远程测试环境：

3、正式生产环境：

四、HTTP请求方式

GET 或 POST

五、接口参数

序号	名称	类型	是否必须	示例值	描述
1	name	String	是	无	无
2	code	String	是	无	无

六、返回结果

序号	名称	类型	是否必须	示例值	描述
1	name	String	是	无	无
2	code	String	是	无	无

七、返回示例

JSON示例
{ "name":"test", "code":"0" }

 

八、结果代码

暂无

九、注意事项

暂无

十、备注说明

暂无

转载于:https://my.oschina.net/u/1251467/blog/669989