还不快抢沙发

添加新评论

### HTTP的请求方式 GET:从服务器`取出`资源(一项或多项) POST:在服务器`新建`一个资源 PUT:在服务器`更新`资源 DELETE:从服务器`删除`资源 下面是一些例子。 GET /product:列出所有商品 POST /product:新建一个商品 GET /product/1:获取某个指定商品的信息 PUT /product/1:更新某个指定商品的信息 DELETE /product/1:删除某个商品 GET /product/1/purchase :列出某个指定商品的所有投资者 GET /product/1/purchase/2:获取某个指定商品的指定投资者信息 ### 状态码 200:请求成功 404:请求资源不存在 500:服务器内部错误 ### 请求参数 #### 1)url参数 例如/api/product/122 122为产品编号,获取产品为122的信息 #### 2)请求body 参数统一以表单x-www-form-urlencoded提交,例如username=zhangsan&password=123456 #### 3)请求header 一般用于用户权限的认证,如auth-jwt:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC93d3cuZGFuZ2tvdS5uZXRcLyIsImF1ZCI6Imh0dHA6XC9cL3d3dy5kYW5na291Lm5ldFwvIiwiaWF0IjoxNTEwNjY0OTU1LCJuYmYiOjAsImV4cCI6MTUxMDY3MjE1NSwidG9rZW5faWQiOiIxNzkyZGZhMmYwN2NiM2YwMGU4OWQxMDg4ZWE5YWE0NSJ9.8isnVmEe_PkQFNfLIwBTFtgFjJ-SFqHqlF2NFhrO6oA ### 过滤信息 如果记录数量很多,服务器不可能都将它们返回给用户。API应该提供参数,过滤返回结果。 下面是一些常见的参数。 ?limit=10:指定返回记录的数量 ?offset=10:指定返回记录的开始位置。 ?page=2&per_page=100:指定第几页,以及每页的记录数。 ?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序。 ?producy_type=1:指定筛选条件 ### 返回结果 为了规范返回的数据,采用固定的json数据格式。 | 字段 | 类型 | 说明 | 示例 | |--------|--------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | status | Int | 错误码 | 正常0,错误2002 | | data | String | 业务的主数据 | 一般为json格式字符串,如"{\"id\":1,\"username\":\"zhangsan\"}" | | msg | String | 错误信息 | 用户名没有填写 > Tips: * 为了方便开发时观察数据,添加header参数preview-data : 1,将可以获得data预解析的结果 * 只要是由程序控制返回的结果,状态码都应是200 ### 用RAP平台管理API RAP是一个GUI的WEB接口管理工具。在RAP中,您可定义接口的URL、请求&响应细节格式等等。通过分析这些数据,RAP提供MOCK服务、测试服务等自动化工具。RAP同时提供大量企业级功能,帮助企业和团队高效的工作。 #### 1) 什么是RAP? 在前后端分离的开发模式下,我们通常需要定义一份接口文档来规范接口的具体信息。如一个请求的地址、有几个参数、参数名称及类型含义等等。RAP 首先方便团队录入、查看和管理这些接口文档,并通过分析结构化的文档数据,重复利用并生成自测数据、提供自测控制台等等... 大幅度提升开发效率。 #### 2) RAP的特色 强大的GUI工具 给力的用户体验,你将会爱上使用RAP来管理您的API文档。 完善的MOCK服务 文档定义好的瞬间,所有接口已经准备就绪。有了MockJS,无论您的业务模型有多复杂,它都能很好的满足。 庞大的用户群 RAP在阿里巴巴有200多个大型项目在使用,也有许多著名的公司、开源人士在使用。RAP跟随这些业务的成行而成长,专注细节,把握质量,经得住考验。 免费 + 专业的技术支持 RAP是免费的,而且你的技术咨询都将在24小时内得到答复。大多数情况,在1小时内会得到答复。 RAP是一个可视化接口管理工具 通过分析接口结构,动态生成模拟数据,校验真实接口正确性, 围绕接口定义,通过一系列自动化工具提升我们的协作效率。我们的口号:提高效率,回家吃晚饭!