RESTful api接口设计规范

摘星喵Pro

已于 2022-08-02 16:05:55 修改

阅读量1.3k

点赞数

于 2022-07-29 16:29:03 首次发布

转载请注明原创链接

本文链接：https://blog.csdn.net/a2272062968/article/details/126058701

版权

java 同时被 2 个专栏收录

99 篇文章 39 订阅

订阅专栏

web

63 篇文章 3 订阅

订阅专栏

RESTful架构是一种互联网软件架构风格，强调资源、表现层和状态转化。API通信通常使用HTTPS，部署在专用域名下，有版本控制，使用HTTP动词（GET, POST, PUT, DELETE等）表示操作，路径表示资源，过滤信息，状态码反馈操作结果。错误处理清晰，返回结果格式化。Java开发中遵循驼峰命名法，提供API接口文档和注释规范。

摘要由CSDN通过智能技术生成

1.理解RESTful

REST，即Representational State Transfer的缩写，是对互联网软件的架构原则。如果一个架构符合REST原则，就称它为RESTful架构。要理解RESTful架构，最好的方法就是去理解Representational State Transfer这个词组到底是什么意思，它的每一个词代表了什么涵义。Representational State Transfer直译为"表述性状态转移"或“表现层状态转化”。

资源（Resources）

REST的名称"表现层状态转化"中，省略了主语。“表现层"其实指的是"资源”（Resources）的"表现层"。

所谓"资源"，就是网络上的一个实体，或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的实在。你可以用一个URI（统一资源定位符）指向它，每种资源对应一个特定的URI。要获取这个资源，访问它的URI就可以，因此URI就成了每一个资源的地址或独一无二的识别符。

表现层（Representation）

“资源"是一种信息实体，它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式，叫做它的"表现层”（Representation）。

比如，文本可以用txt格式表现，也可以用HTML格式、XML格式、JSON格式表现，甚至可以采用二进制格式；图片可以用JPG格式表现，也可以用PNG格式表现。

URI只代表资源的实体，不代表它的形式。严格地说，有些网址最后的".html"后缀名是不必要的，因为这个后缀名表示格式，属于"表现层"范畴，而URI应该只代表"资源"的位置。它的具体表现形式，应该在HTTP请求的头信息中用Accept和Content-Type字段指定，这两个字段才是对"表现层"的描述。

状态转化（State Transfer）

访问一个网站，就代表了客户端和服务器的一个互动过程。在这个过程中，势必涉及到数据和状态的变化。

互联网通信协议HTTP协议，是一个无状态协议。这意味着，所有的状态都保存在服务器端。因此，如果客户端想要操作服务器，必须通过某种手段，让服务器端发生"状态转化"（State Transfer）。而这种转化是建立在表现层之上的，所以就是"表现层状态转化"。

客户端用到的手段，只能是HTTP协议。具体来说，就是HTTP协议里面，四个表示操作方式的动词：GET、POST、PUT、DELETE。它们分别对应四种基本操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源。

综合上面的解释，我们总结一下什么是RESTful架构：

（1）每一个URI代表一种资源；

（2）客户端和服务器之间，传递这种资源的某种表现层；

（3）客户端通过四个HTTP动词，对服务器端资源进行操作，实现"表现层状态转化"。

2.协议

API与用户的通信协议，总是使用HTTPS协议。

3.域名

应该尽量将API部署在专用域名之下。

https://api.example.com

如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。

https://example.org/api/

4.版本（Versioning）

第一种做法是将API的版本号放入URL。

https://api.example.com/v1/

另一种做法是，将版本号放在HTTP头信息中，但不如放入URL方便和直观。Github采用这种做法。

应当加版本信息，但是放url中的不常见，建议放到header中。

5.路径（Endpoint）

路径又称"终点"（endpoint），表示API的具体网址。

在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。一般来说，数据库中的表都是同种记录的"集合"（collection），所以API中的名词也应该使用复数。

举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。

https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees

6.HTTP动词

对于资源的具体操作类型，由HTTP动词表示。

常用的HTTP动词有下面五个（括号里是对应的SQL命令）。

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：从服务器删除资源。

还有两个不常用的HTTP动词。

HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

下面是一些例子。

GET /zoos：列出所有动物园
POST /zoos：新建一个动物园
GET /zoos/ID：获取某个指定动物园的信息
PUT /zoos/ID：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/ID：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/ID：删除某个动物园
GET /zoos/ID/animals：列出某个指定动物园的所有动物
DELETE /zoos/ID/animals/ID：删除某个指定动物园的指定动物

7.过滤信息（Filtering）

如果记录数量很多，服务器不可能都将它们返回给用户。API应该提供参数，过滤返回结果。

下面是一些常见的参数。

?limit=10：指定返回记录的数量
?offset=10：指定返回记录的开始位置。
?currentPage=2&pageSize=100：指定第几页，以及每页的记录数。
?sortby=name&order=asc：指定返回结果按照哪个属性排序，以及排序顺序。
?animal_type_id=1：指定筛选条件

参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

8.状态码（Status Codes）

服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

状态码的完全列表参见这里。

9.错误处理（Error handling）

如果状态码是4xx，就应该向用户返回出错信息。一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

{    error: "Invalid API key" }

10.返回结果

针对不同操作，服务器向用户返回的结果应该符合以下规范。

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

11.Hypermedia API

RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。

比如，当用户向api.example.com的根目录发出请求，会得到这样一个文档。

{"link": {  "rel":   "collection https://www.example.com/zoos",  "href":  "https://api.example.com/zoos",  "title": "List of zoos",  "type":  "application/vnd.yourformat+json" }}

上面代码表示，文档中有一个link属性，用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系（collection关系，并给出该collection的网址），href表示API的路径，title表示API的标题，type表示返回类型。

Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。

{  "current_user_url": "https://api.github.com/user",  "authorizations_url": "https://api.github.com/authorizations",  // ... }

从上面可以看到，如果想获取当前用户的信息，应该去访问api.github.com/user ，然后就得到了下面结果。

{  "message": "Requires authentication",  "documentation_url": "https://developer.github.com/v3" }
上面代码表示，服务器给出了提示信息，以及文档的网址。

12.其他

（1）API的身份认证应该使用OAuth 2.0框架。

（2）服务器返回的数据格式，应该尽量使用JSON，避免使用XML。

13.java开发restful伪代码样例

import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PatchMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONObject;
 
@RestController
@RequestMapping("/test")
public class TestController {
    /**
     * 方法名称：config
     * 方法描述：获取配置列表资源
     * 创建时间：
     * @return
     * * JSONArray
     *
     * @author by
     **/
    @GetMapping("/config")
    public JSONArray config() {
        JSONArray jsonArray = new JSONArray();
        jsonArray.add("a");
        jsonArray.add("b");
        jsonArray.add("c");
        return jsonArray;
    }
 
    /**
     * 方法名称：config
     * 方法描述：获取指定id的配置
     *  创建时间：
     * @param id
     * @return 
     * * JSONObject
     *
     * @author by
     **/
    @GetMapping("/config/{id}")
    public JSONObject config(@PathVariable(value = "id") String id) {
        JSONObject json = new JSONObject();
        json.put("id", id);
        json.put("msg", "获取");
        return json;
    }
 
    /**
     * 方法名称：delete
     * 方法描述：删除指定id的配置
     *  创建时间：
     * @param id
     * @return
     * * JSONObject
     *
     * @author by
     **/
    @DeleteMapping("/config/{id}")
    public JSONObject delete(@PathVariable(value = "id") String id) {
        JSONObject json = new JSONObject();
        json.put("id", id);
        json.put("msg", "删除");
        return json;
    }
 
    /**
     * 方法名称：save
     * 方法描述：新增配置
     *  创建时间：
     * @param id
     * @return 
     * * JSONObject
     *
     * @author by
     **/
    @PostMapping("/config/")
    public JSONObject save(String id) {
        JSONObject json = new JSONObject();
        json.put("id", id);
        json.put("msg", "新增");
        return json;
    }
 
    /**
     * 方法名称：update
     * 方法描述：全量修改指定id的配置
     * 创建时间：
     * @param id
     * @return 
     * * JSONObject
     *
     * @author by
     **/
    @PutMapping("/config/{id}")
    public JSONObject update(@PathVariable(value = "id") String id) {
        JSONObject json = new JSONObject();
        json.put("id", id);
        json.put("msg", "修改");
        return json;
    }
 
    /**
     * 方法名称：patchUpdate
     * 方法描述：修改指定id的部分属性
     * 创建时间：
     * @param id
     * @return 
     * * JSONObject
     *
     * @author by
     **/
    @PatchMapping("/config/{id}")
    public JSONObject patchUpdate(@PathVariable(value = "id") String id) {
        JSONObject json = new JSONObject();
        json.put("id", id);
        json.put("msg", "patch修改");
        return json;
    }
}

14.java语言-接口请求参数与响应内容规范

1.请求与响应的字段名称都使用驼峰命名法表示。

2.参数名称使用有意义的英文表示。

3.对于字段取值只有2种的状态码，如 is_deleted(是否已删除)，使用 true|false 作为返回值；对于多状态码的字段，使用数值类型或枚举类型表示，需说明每个状态码代表含义。

15.java语言-对外API接口文档及注释规范

Java语言开发项目，使用代码注释来直接生成接口文档，使用的工具包为 apidoc ，官方文档 apidoc github地址

使用样例


/**
 * @api {POST} /config/checkName 校验配置名称是否重复
 * @apiGroup Config: BaseInfo
 * @apiVersion 1.0.0
 * @apiDescription 新增或编辑配置基本信息时，校验配置名称是否重复
 * @apiParam (请求体参数){Number} type 类型, 1 为事件识别, 2 为实体布控
 * @apiParam (请求体参数){String} name 需要校验的配置名称
 * @apiParam (请求体参数){String} [topicCateId] 专题分类code, 仅当事件识别时有效且必须
 * @apiParam (请求体参数){String}[excludeConfigId] 排除的配置id
 * @apiExample {curl} 请求样例:
 *          POST /config/checkName
 *          {
 *               "type": 1,
 *               "name": "配置",
 *               "topicCateId": "200100"
 *           }
 * @apiSuccess (返回参数) {String} message 回馈信息
 * @apiSuccess (返回参数) {String} code 200 代表无错误，其他代表有错误
 * @apiSuccessExample {json} 返回样例:
 *          {
 *               "code":"200",
 *               "message":"名字可用"
 *          }
 */
@RequestMapping("/config/checkName")
@ResponseBody
public JSONObject checkName(@RequestBody CheckNameParamsVo vo)throws InvalidParamException{
        //代码略
}
 
/**
 * @api {get} /config/queryWordsBases 从数据库中查询配置的标准词库
 * @apiGroup Config: Words
 * @apiVersion 1.0.0
 * @apiDescription 从数据库中查询某条配置的标准词库
 *
 * @apiParam (Path 参数){String} configId 配置id
 * @apiExample 请求样例
 *        GET /config/queryWordsBases?configId=0EF130646796412E90E29B37E8B1E5E2
 *
 * @apiSuccess (返回参数) {String} message 回馈信息
 * @apiSuccess (返回参数) {String} code 200代表无错误，其他代表有错误
 * @apiSuccess (返回参数) {String} data 返回数据
 * @apiSuccessExample {json} 返回样例与解释
 *           {
 *                "code":"200",
 *                "message":"查询成功",
 *                "data":{
 *                          "totalList": [
 *                                  { 
 *                                        "wordsBaseId": "词库id",
 *                                        "version": "词库版本号"
 *                                        "topicName": "所属专题",
 *                                        "topicCateName": "专题分类",
 *                                        "wordsCount": 控词个数,
 *                                        "creatTime": "创建时间",
 *                                        "createUser":"创建人"
 *                                  },
 *                                 {
 *                                        "wordsBaseId": "词库id",
 *                                        "version": "词库版本号"
 *                                        "topicName": "所属专题",
 *                                        "topicCateName": "专题分类",
 *                                        "wordsCount": 控词个数,
 *                                        "creatTime": "创建时间",
 *                                        "createUser":"创建人"
 *                                  }
 *                             ]
 *                 }
 *          }
 */
@RequestMapping("/config/queryWordsBases")
@ResponseBody
public JSONObject queryWordsBases(@RequestParam(required = true) String configId){
        //代码略
}