RESTFul API设计指南及使用说明

RESTFul API设计指南及使用说明

一、 协议
API与用户的通信协议,使用HTTP协议。


二、 域名
应尽量将API部署在专用域名之下
也可以将API放在主域名下

三、 版本
应该将API的版本号放入URL

四、 路径与映射
REST的关键原则与将你的API分割成逻辑资源紧密相关。使用HTTP请求控制这些资源,

RESTFul原则提供了HTTP methods映射作为策略来处理CRUD actions,


需要继承Resource父类如下:

@API():类注解,括号类为类请求路径,如@API("/api/v1.0")

@GET():方法注解,查询,括号内为方法请求路径,如GET("/user"),如果通过API直接访问,括号可不加
@GET("/:id"):方法注解,根据ID查询,括号内表示可根据ID直接查询结果
@POST():方法注解,新增,括号内为方法请求路径,如果通过API直接访问,括号可不加
@PUT():方法注解,修改,括号内为方法请求路径,如果通过API直接访问,括号可不加
@DELETE():方法注解,删除,括号内为方法请求路径,如果通过API直接访问,括号可不加


五、 资源(Model)常用方法,需要继承Model父类
1:findBy(String where,Object... params):根据条件查询

1 public List<M> findBy(String username,String password){ 2 Model modelDao = new Model(); 3 List<M> list = modelDao.findBy("username=? AND password=?",username,password); 4 return list; 5 }

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wpffxz.html