Spring Boot整合swagger2，搭建Restful API在线文档

        Swagger,中文“拽”的意思，它是一个强大的在线API文档的框架，目前它的版本是2.x,所以称为“swagger2”。swagger2提供了在线文档的查阅和测试功能。利用Swagger2很容易构建RESTful分格的API,在Spring Boot中集成Swagger2.

     (1)、引入依赖
 
   (2)、配置Swagger2(这个配置类需要和启动类在统一目录下)

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.camelot.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot利用swagger构建api文档")
                .description("简单优雅的restfun风格，http://blog.csdn.net/forezp")
                .termsOfServiceUrl(" http://blog.csdn.net/forezp")
                .contact(new Contact("Dai.Owen","http://www.baidu.com","daihuhu@camelotchina.com"))
                .version("1.0")
                .build();
    }
}

（3）|写生成文档的注解

Swagger通过注解来生成API接口文档，文档信息包括接口名、请求方法、参数、返回信息等。通常情况下用于生成在线API文档，简单介绍一下的注解

（4）、编写Service层代码

1. @ApI  :修饰整个类，用户描述Controller类。
2. @ApiOperation:描述类的方法、或者一个接口。
3. @ApiModel:用对象来接受参数
4. @ApiParam :用参数来接收参数
5. @ApiProperty:用对象来接收参数时，描述对象的一个字段
6. @ApiResponse:HTTP响应的一个描述
7. @ApiResponses:HTTP响应的整体描述
8. @ApiIgnore：使用该注解，表示Swagger2忽略这个API。
9. @ApiError：发生错误返回的信息。
10. @ApiError:发生错误返回的信息
11. @ApiParamImplicit:一个请求参数
12. @ApiParamsImplicit:多个请求参数

（4）、编写Service层代码

package com.camelot.demo.service;

import com.camelot.demo.dao.UserDao;
import com.camelot.demo.entity.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {
    @Autowired
    private UserDao userRepository;


    public User saveUser(User user) {
        return userRepository.save(user);
    }

    public void deleteUser(User user) {
        userRepository.delete(user);
    }

    public void deleteUserById(long Id) {
        userRepository.deleteById(Id);
    }

    public User updateUser(User user) {
        return userRepository.saveAndFlush(user);
    }

    public User findUserByUserName(String username) {
        return userRepository.findByUsername(username);
    }

    public List<User> findAll() {
        return userRepository.findAll();
    }

    public User findUserById(long id) {
        return userRepository.findById(id);
    }
}

（5）、Web层。在web层通过Get、Post、Delete、Put这4种方法HTTP方法，构建一组以资源为中心的RESTful风格的API接口。

@RequestMapping("/user")
@RestController
public class UserController {
    @Autowired
    private UserService userService;

   //这个注解主要是描述生成在线文档的具体API的说明,属性value为该接口的名称，notes值为该接口的详细文档说明
    @ApiOperation(value = "用户列表", notes = "用户列表")
    @RequestMapping(value = "", method = RequestMethod.GET)
    public List<User> getUsers() {
        return userService.findAll();
    }

    @ApiOperation(value = "创建用户", notes = "创建用户")
    @RequestMapping(value = "", method = RequestMethod.POST)
    public User postUser(@RequestBody User user) {
        return userService.saveUser(user);
    }

    @ApiOperation(value = "获取用户详细信息", notes = "根据user的Id来获取用户的详细信息")
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    public User getUser(@PathVariable Long id) {
        return userService.findUserById(id);
    }

    @ApiOperation(value = "修改用户信息", notes = "根据用户的id来修改用户的信息")
    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
    public User putUser(@PathVariable Long id, @RequestBody User user) {
        User user1 = new User();
        user1.setUsername(user.getUsername());
        user1.setPassword(user.getPassword());
        user1.setId(id);
        return userService.updateUser(user1);
    }

    @ApiOperation(value = "删除用户", notes = "根据用户的id来删除用户的信息")
    @RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
    public String deleteUser(@PathVariable long id) {
        userService.deleteUserById(id);
        return "success!!!";
    }

    @Ignore //使用这个注解后，将忽略这个API
    @RequestMapping(value = "/hi", method = RequestMethod.GET)
    public String jsonTest() {
        return "Greeting from Dai.Owen!";
    }
}

（6）、启动工程，在浏览器上访问http://localhost:8080/swagger-ui.html