Swagger2生成RESTful API

Swagger2生成RESTful API

文章内容来自于：http://www.spring4all.com/article/251，作者：程序员DD
文章主要用于自己学习SpringBoot，方便以后的查询

如何使用Swagger2：

1.添加pom依赖：

<!--添加Swagger2依赖-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.2.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.2.2</version>
        </dependency>

2.在与Application.java同级目录下创建Swagger.java：

@Configuration //通过@Configuration注解，让Spring来加载该类配置
@EnableSwagger2 //通过@EnableSwagger2注解来启用Swagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi(){//通过createRestApi()函数创建Docket的Bear之后
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()) //apiInfo()用来创建Api的基本信息（这些信息会展现在文档页面中）
                .select() //select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现
                .apis(RequestHandlerSelectors.basePackage("com.chimm.web")) //本例采用指定扫描的包路径来定义
                .paths(PathSelectors.any())                                 //Swagger会扫描该包下的所有Controller定义的API，并产生文档内容（除了被@ApiIgnore定义的请求）
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("更多Spring boot相关文章请关注：http://blog.didispace.com/")
                .termsOfServiceUrl("https://blog.csdn.net/qq_36704469/article/details/80227353")
                .contact("吃茫茫")
                .version("1.0")
                .build();
    }

如上代码所示，通过@Configuration注解，让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。

再通过createRestApi()函数创建Docket的Bean之后，apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，本例采用指定扫描的包路径来定义，Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。

3.添加文档内容

@RestController
@RequestMapping("/users") //通过这里配置使下面的映射都在/users下。可去除
public class UserController {

    /* 创建【线程安全】的Map（悲观锁）
       缺点：从锁的角度来看，Collections.synchronizedMap直接锁住了
             尽可能大的代码块，性能会比较差
     */
    static Map<Long,User> users = Collections.synchronizedMap(new HashMap<Long, User>());


    @ApiOperation(value = "获取用户列表",notes = "")
    @RequestMapping(value = "/",method = RequestMethod.GET)
    public List<User> getUserList(){
        // 处理"/users"的GET请求，用来获取用户列表
        // 还可以通过@RequestParam从页面中传递参数来进行查询条件或者翻页信息的传递
        List<User> userList = new ArrayList<>(users.values());
        return userList;
    }


    @ApiOperation(value = "创建用户",notes = "根据User对象创建用户")
    @ApiImplicitParam(name = "user",value = "用户详细实体user",required = true,dataType = "User")
    @RequestMapping(value = "/",method = RequestMethod.POST)
    public String postUser(@ModelAttribute User user){
        // 处理"/users"的POST请求，用来创建User
        // 除了@ModelAttribute绑定参数之外，还可以通过@RequestParam从页面传递参数
        users.put(user.getId(),user);
        return "success";
    }


    @ApiOperation(value = "获取用户详细信息",notes = "根据url的id来获取用户详细信息")
    @ApiImplicitParam(name = "id",value = "用户ID",required = true,dataType = "Long")
    @RequestMapping(value = "/{id}",method = RequestMethod.GET)
    public User getUser(@PathVariable("id") Long id){
        // 处理"/users/{id}的GET请求，用来获取url中id值的User信息"
        // url中的id可通过@PathVariable绑定到函数的参数中
        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,@ModelAttribute User user){
        // 处理"/users/{id}"的PUT请求，用来更新User信息
        User u = users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id,u);
        return "success";
    }


    @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/{id}"的DELETE请求，用来删除User
        users.remove(id);
        return "success";
    }
}

完成上述代码添加上，启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html。就可以查看API文档了。如下图