REST接口开发规范_第1页
REST接口开发规范_第2页
REST接口开发规范_第3页
全文预览已结束

下载本文档

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

文档简介

REST接口开发规范和约定1.1 REST API约定REST方式实现服务接口需要提供标准API文件，本项目采用swagger2.0生成的文档做为服务接口的API文件。各服务提供方在提供服务接口的同时，需要提供通过swagger2.0生成的服务API文件，具体实现方式可以参考swagger的官方网站：“http:/swagger.io“。生成的swagger.json文件内容如下：图4.5-1 swagger.json1.2 REST接口服务命名规范REST接口服务的URL由以下三部分组成：“域名/IP：端口号”+“/basePath”+“/资源名”。 1.2.1 域名 组成域名信息由专商所制定，测试阶段使用IP+端口方式提供。 示例“http:/172.16.74.xx:8090”1.2.2 basePath命名规范 组成basePath由两部分组成：“/px”+“/系统名称”。v /pxpx为开发商代号：p1：包一。p2：包二。p3：包三。v /系统名称各包开发的系统模块的名称，例如：crm。 原则v basePase的命名采用英文。v 英文统一采用小写。 示例“/p2/crm”1.2.3 资源名 组成资源名可参考REST命名规范进行命名，资源名尽量为名词，简明展示所请求的资源信息。 原则v 资源名的命名采用英文。v 英文统一采用小写，如有联合单词，建议采用驼峰命名法。 示例“/application/name”【下载本文档，可以自由复制内容或自由编辑修改内容，更
人人文库> 全部分类> 应用文书 > 项目管理

温馨提示

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

最新文档

评论

0/150

提交评论