公司接口命名规范

公司接口命名规范

基本概念

Http定义了与服务器交互的不同方法，最基本的方法有4种，分别是GET，POST，PUT，DELETE。URL全称是资源描述符，我们可以这样认为：一个URL地址，它用于描述一个网络上的资源，而HTTP中的GET，POST，PUT，DELETE就对应着对这个资源的查，改，增，删4个操作。

get、put、post、delete含义与区别

get

GET请求会向数据库发索取数据的请求，从而来获取信息，该请求就像数据库的select操作一样，只是用来查询一下数据，不会修改、增加数据，不会影响资源的内容，即该请求不会产生副作用。无论进行多少次操作，结果都是一样的。

put

与GET不同的是，PUT请求是向服务器端发送数据的，从而改变信息，该请求就像数据库的update操作一样，用来修改数据的内容，但是不会增加数据的种类等，也就是说无论进行多少次PUT操作，其结果并没有不同。

post

POST请求同PUT请求类似，都是向服务器端发送数据的，但是该请求会改变数据的种类等资源，就像数据库的insert操作一样，会创建新的内容。几乎目前所有的提交操作都是用POST请求的。

delete

DELETE请求顾名思义，就是用来删除某一个资源的，该请求就像数据库的delete操作。

接口命名规范

注解

url

描述

@GetMapping

/user/{id}

查询单个user

 

/users

查询users

 

/users:search

分页查询users

@PostMapping

/user

新增单个user

@PutMapping

/user/{id}

修改单个user

 

/users/{ids}

修改users

 

/user:enable

禁用user

@DeleteMapping

/user/{id}

删除单个user

 

/users/{ids}

删除users

RestResult使用规范

只有在你的接口没有返回值时才会使用RestResult,比如在一般的新增、修改、删除操作后；其他情况下只需正常写返回值即可，如返回int、List、Map