API 文档规约

## 一、Access Token > Authorization: Bearer af72c6e1-d15d-483a-84d2-a803c9328518 **除了以下API可以不携带 access_token, 其他都要携带:** 1. 明确规定可以不携带的 API 2. url 匹配 `/pub/**` 的API ==**说明中存在可带也可不带的 API,全部携带 access_token**== ## 二、请求方法(Method) **GET:获取资源:** 某些场景下,服务端可以响应给客户端数据可以缓存,并设置缓存时间和缓存失效机制。客户端按服务端设置缓存时间和机制缓存数据,提高性能 **POST:向服务端提交数据:** 很多情况下使用 flowNo机制,防止重复提交。 服务端通过flowNo控制禁止重复提交。 **PUT:修改数据** 服务端实现幂等情况,原则上可以安全的重复提交,不过为了避免无意义的请求,客户端在处理PUT请求时,应该做防止重复提交处理。 服务端不严格禁止重复提交。 **DELETE:删除数据** 同 PUT 请求 **POST,PUT,DELETE共同:** 注意刷新页面(请求获取最新数据集) ## 三、flowNo机制 **flowNo生命周期:** ![未命名文件.png](https://cos.easydoc.net/57145150/files/k4f4nv1i.png) **flowNo获取:** 客户端应该在进入表单时获取flowNo, 不能在提交时获取并提交数据