code 规范

前端对接：-------------------------

RESTful API 设计指南 http://www.ruanyifeng.com/blog/2014/05/restful_api.html

其中：

仅做个人备份，浏览请看原文

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

域名+版本：
https://example.org/api/v1

类型：
GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
DELETE（DELETE）：从服务器删除资源。
HEAD：获取资源的元数据。
OPTIONS：获取信息，关于资源的哪些属性是客户端可以改变的。

url范例：
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：删除某个指定动物园的指定动物 

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

状态码：
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 - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。

------

url 不驼峰 用-隔开

------

api例：
//更新运单号
adminRouter.PUT("/orders/:orderID/deliver", deliver)
//快递100回调
adminRouter.POST("/deliveries/:deliveryID/callback", kuaidi100Callback)

------

缩写要大写：
    id和tplID/tplCRM

------

url参数时冲突的情况

有冲突：
    //删除导航
    v2.DELETE("/navigations/:id", deleteNavigations)
    //编辑导航分类 分类的增删改 需要重排分类顺序
    v2.POST("/navigations/categories/:id", updateNavigationsCategories)

改为：
        //删除导航
    v2.DELETE("/navigations/:id", deleteNavigations)
    //编辑导航分类 分类的增删改 需要重排分类顺序
    v2.POST("/navigations/:id/categories", updateNavigationsCategories)

所以说规范都是总结出来的

 

后端内部：-------------------------

导包顺序：
内置
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/url"
第三方
"github.com/sirupsen/logrus"
自己
"gitlab.haibaodianjing.com/maoqiudao/server/pkg/consts"
"gitlab.haibaodianjing.com/maoqiudao/server/pkg/model"
"gitlab.haibaodianjing.com/maoqiudao/server/pkg/model/request"
"gitlab.haibaodianjing.com/maoqiudao/server/pkg/model/response"
"gitlab.haibaodianjing.com/maoqiudao/server/pkg/store"

------

方法名：例 

简洁

deliver  

deliveryCallback

UpdateOrderStatus

UpdateDeliveryInfo

SubscribeDelivery

DoPostForm

UpdateDeliveryStatus

------

url 基路径 例如: AdminRootPath = "/api/v1/plate/admin/"  一定要有 ‘模块 + 平台’ 否则gateway不好配