RESTful API设计规范

HTTP方法

URI

方法名

参数

示例

备注

GET

/resource

index

@RequestMapping()

@ResponseBody

Public Result index(Domain condition)

显示所有资源

GET

/resource/1

show

Id=1

@RequestMapping(path=”{id}”)

@ResponseBody

public Result show(@PathVariable Long id)

显示单个资源

GET

/resource/1/edit

edit

Id=1

@RequestMapping(path=”{id}/edit”)

@ResponseBody

public Domain edit(@PathVariable Long id);

编辑单个资源

GET

/resource/new

editNew

@RequestMapping(path=”new”);

public String editNew();

新建

POST

/resource

create

@RequestMapping(method=RequestMethod.POST);

@ResponseBody

public Result create(Domain domain);

创建单个资源

PUT

/resource/1

update

Id=1

@RequestMapping(path=”{id}”,method=RequestMethod.UPDATE);

@ResponseBody

public Result update(@PathVariable Long id);

更新单个资源

DELETE

/resource/1

destroy

Id=1

@RequestMapping(path=”{id}”,method=RequestMethod.DELETE);

@ResponseBody

public Result destroy(@PathVariable Long id);

删除单个资源

POST

/resource/batch/create

batchCreate

@RequestMapping(path=”batch/create”,method=RequestMethod.POST);

@ResponseBody

public Result batchCreate(List<Domain> domains);

创建多个资源

POST

/resource/batch/update

batchUpdate

@RequestMapping(path=”batch/update”,method=RequestMethod.POST);

public Result

@ResponseBody

batchUpdate(List<Domain> domains);

更新多个资源

POST

/resource/batch/destroy

batchDestroy

@RequestMapping(path=”batch/destroy”,method=RequestMethod.POST);

@ResponseBody

public Result batchDestroy(List<Domain> domains);

删除多个资源

POST/GET

/resource/action

action

@RequestMapping(path=”action”);

@ResponseBody

public Result action(参数);

对资源的其他操作