REST接口开发规范

REST接口开发规范和约定

1.1REST API约定

REST方式实现服务接口需要提供标准API文件，本项目采用swagger2.0生成的文档做为服务接口的API文件。

各服务提供方在提供服务接口的同时，需要提供通过swagger2.0生成的服务API文件，具体实现方式可以参考swagger的官方网站：“http://swagger.io “。

生成的swagger.json文件内容如下：

图4.5-1 swagger.json

1.2REST接口服务命名规范

REST接口服务的URL由以下三部分组成：

“域名/IP：端口号”+“/basePath”+“/资源名”。

1.2.1域名

➢组成

域名信息由专商所制定，测试阶段使用IP+端口方式提供。

➢示例

“http://172.16.74.xx:8090”

1.2.2basePath命名规范

➢组成

basePath由两部分组成：“/px”+“/系统名称”。

❖/px

px为开发商代号：

p1：包一。

p2：包二。

p3：包三。

❖/系统名称

各包开发的系统模块的名称，例如：crm。

➢原则

❖basePase的命名采用英文。

❖英文统一采用小写。

➢示例

“/p2/crm”

1.2.3资源名

➢组成

资源名可参考REST命名规范进行命名，资源名尽量为名词，简明展示

所请求的资源信息。

➢原则

❖资源名的命名采用英文。

❖英文统一采用小写，如有联合单词，建议采用驼峰命名法。

➢示例

“/application/name”