微服务接口定义规范_第1页
微服务接口定义规范_第2页
微服务接口定义规范_第3页
微服务接口定义规范_第4页
微服务接口定义规范_第5页
已阅读5页，还剩7页未读， 继续免费阅读

付费下载

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

西安景兆科技有限公司西安景兆科技有限公司接口定义规范研发部西安景兆科技有限公司西安景兆科技有限公司2018/01西安景兆科技有限公司西安景兆科技有限公司1URI命名规范32使用HTTP方法表示动作行为43使用HTTP内容协商处理资源表示内容44使用HTTP响应状态码标识处理结果状态55使用HALHYPERTEXTAPPLICATIONLANGUAGE作为响应数据格式66各HTTP方法成功处理后的返回数据97不要对返回结果进行封装98支持资源的字段裁剪，减少响应中返回的字段数量109使用OAUTH2来确保API的安全性1010确保GET，PUT，DELETE请求是幂等的1011API版本10西安景兆科技有限公司西安景兆科技有限公司微服务接口设计采用RESTFUL风格的接口规范，下面是基于RESTFUL风格要求制订的接口设计规范。1URI命名规范不用大写；用中杠不用下杠_；参数列表要ENCODE；使用名词作为资源名称例如，不要在网址中使用动词；使用资源集合的概念；每种资源有两类URI（接口）资源集合（例如，/ORDERS）；集合中的单个资源（例如，/ORDERS/ORDERID）。使用复数形式使用ORDERS而不是ORDER；资源名称和ID组合可以作为一个网址的节点；例如，/ORDERS/ORDERID/ITEMS/ITEMID；尽可能的让网址越短越好，单个网址最好不超过三个节点。可以使用查询参数代替路径中的节点组合对COMPOSITE资源的访问服务器端的组合实体必须在URI中通过父实体的ID导航访问。GET/ORDERS/12/ITEMS使用有意义的资源描述；“禁止单纯的使用ID”响应信息中不应该存在单纯的ID，应使用链接或是引用的对象；设计资源的表述信息，而不是简简单单的做数据库表的映射；合并表述信息，不要通过两个ID直接表示两个表的关系；资源的集合应支持过滤，排序和分页；西安景兆科技有限公司西安景兆科技有限公司过滤、排序、分页应出现在
人人文库> 全部分类> 应用文书 > 技术指导

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论