使用swagger构建restful api
This commit is contained in:
@@ -4,9 +4,7 @@ import com.didispace.domain.User;
|
||||
|
||||
import java.util.*;
|
||||
|
||||
import io.swagger.annotations.ApiModel;
|
||||
import io.swagger.annotations.ApiModelProperty;
|
||||
import io.swagger.annotations.ApiOperation;
|
||||
import io.swagger.annotations.*;
|
||||
import org.springframework.web.bind.annotation.*;
|
||||
|
||||
/**
|
||||
@@ -30,6 +28,7 @@ public class UserController {
|
||||
}
|
||||
|
||||
@ApiOperation(value="创建用户", notes="根据User对象创建用户")
|
||||
@ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
|
||||
@RequestMapping(value="", method=RequestMethod.POST)
|
||||
public String postUser(@RequestBody User user) {
|
||||
users.put(user.getId(), user);
|
||||
@@ -37,12 +36,17 @@ public class UserController {
|
||||
}
|
||||
|
||||
@ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息")
|
||||
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
|
||||
@RequestMapping(value="/{id}", method=RequestMethod.GET)
|
||||
public User getUser(@PathVariable Long id) {
|
||||
return users.get(id);
|
||||
}
|
||||
|
||||
@ApiOperation(value="更新用户详细信息", notes="根据url的id来指定更新对象,并根据传过来的user信息来更新用户详细信息")
|
||||
@ApiImplicitParams({
|
||||
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"),
|
||||
@ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
|
||||
})
|
||||
@RequestMapping(value="/{id}", method=RequestMethod.PUT)
|
||||
public String putUser(@PathVariable Long id, @RequestBody User user) {
|
||||
User u = users.get(id);
|
||||
@@ -53,6 +57,7 @@ public class UserController {
|
||||
}
|
||||
|
||||
@ApiOperation(value="删除用户", notes="根据url的id来指定删除对象")
|
||||
@ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long")
|
||||
@RequestMapping(value="/{id}", method=RequestMethod.DELETE)
|
||||
public String deleteUser(@PathVariable Long id) {
|
||||
users.remove(id);
|
||||
|
||||
Reference in New Issue
Block a user