接口文档

接口文档

 接口文档 
 定义业务接口 
 一个应用程序有多个业务,多如: 登录、注册、商品列表、商品详情、订单.... 
 前端请求登录业务时，如何请求的url地址和请求方法method，需不需参数。请求成功之后，后端返回什么样的数据给我呢? 接口文档解决. 
 接口名: 登录接口
 url地址: 请求方法method: get | post | 
 请求参数: username='admin'&password:'123' 
 响应数据:
 

//例如：
商品列表接口
url：http://10.7.162.125/productlist
method:get
请求参数：
响应数据：[{ 
id: 1001,
name: "javascript高级编程",
price: 58.9, 
num: 2
}, {
id: 1002, 
name: "css高级编程",
price: 48.89, 
num: 1 
}, { 
id: 1003, 
name: "html高级编程",
price: 38.89, 
num: 1 
}, { 
id: 1005, 
name: "react高级编程", 
price: 99.88,
num: 1 
}]