springboot-swagger2 Restful接口文档的形成

1、配置类

package com.eba.springboot.swagger2config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
//http://localhost:8088/swagger-ui.html 访问他查看api文档
/**
 * Created by Thinkpad on 2018/2/7.
 *  特别要注意的是里面配置了api文件也就是controller包的路径，不然生成的文档扫描不到接口。
 */
@Configuration //等价于xml的beans，相当于配置文件
public class Swagger2 {
    @Bean //等价于xml里面配置的bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.eba.springboot.web"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo(){
     return  new ApiInfoBuilder()
             .title("springboot利用swagger构建api文档")
             .description("简单优雅的Restful风格")
             .termsOfServiceUrl("http://blog.csdn.net/saytime")
             .version("1.0")
             .build();
    }

}

2、接口处书写

package com.eba.springboot.web;


import com.eba.springboot.bean.JsonResult;
import com.eba.springboot.bean.User;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;


/**
 * Created by Thinkpad on 2018/2/7.
Swagger注解
 swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。
 @Api：修饰整个类，描述Controller的作用
 @ApiOperation：描述一个类的一个方法，或者说一个接口
 @ApiParam：单个参数描述
 @ApiModel：用对象来接收参数
 @ApiProperty：用对象接收参数时，描述对象的一个字段
 @ApiResponse：HTTP响应其中1个描述
 @ApiResponses：HTTP响应整体描述
 @ApiIgnore：使用该注解忽略这个API
 @ApiError ：发生错误返回的信息
 @ApiImplicitParam：一个请求参数
 @ApiImplicitParams：多个请求参数
 */
@RestController
public class UserController {


    /**
     * 根据id查询用户用GET
     * @return
     */
    @ApiOperation(value="获取用户的详细信息",notes = "根据url的id获取用户的详细信息")
    @ApiImplicitParam(name = "id",value = "用户ID",required = true,dataType = "Integer",paramType = "path")
    @RequestMapping(value = "user/{id}",method = RequestMethod.GET)
    public ResponseEntity<JsonResult> getUserById(@PathVariable(value = "id") Integer id){
        JsonResult r=new JsonResult();
        User user=new User();
        user.setId(id);
        user.setUsername("yufei");
        user.setPwd("123");
        r.setResult(user);
        r.setStatus("ok");
        return ResponseEntity.ok(r);
    }


    /**
     * 查询用户列表
     * @return
     */
    @ApiOperation(value = "获取用户列表",notes ="获取用户列表" )
    @RequestMapping(value = "users",method = RequestMethod.GET)
    public ResponseEntity<JsonResult> getUserlist(){
        JsonResult r=new JsonResult();
        r.setResult("已经获取到了");
        r.setStatus("ok");
    return ResponseEntity.ok(r);
    }


    /**
     * 添加用户
     * @return
     */
    @ApiOperation(value = "添加用户信息",notes = "根据User对象创建用户")//用户描述方法或类的作用
   @ApiImplicitParam(value = "用户详细实体User",name = "user",required = true,dataType = "User")
  @RequestMapping(value = "user",method = RequestMethod.POST)
    public ResponseEntity<JsonResult> add(@RequestBody  User user){
        JsonResult r=new JsonResult();
        r.setResult("已经获取到了");
        r.setStatus("ok");


        return ResponseEntity.ok(r);
    }
    /**
     * 根据id删除用户
     * @param id
     * @return
     */
    @ApiOperation(value="删除用户", notes="根据url的id来指定删除用户")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long", paramType = "path")
    @RequestMapping(value = "user/{id}", method = RequestMethod.DELETE)
    public ResponseEntity<JsonResult> delete (@PathVariable(value = "id") Integer id){
        JsonResult r = new JsonResult();
        return ResponseEntity.ok(r);
    }


    /**
     * 根据id修改用户信息
     * @param user
     * @return
     */
    @ApiOperation(value="更新信息", notes="根据url的id来指定更新用户信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long",paramType = "path"),
            @ApiImplicitParam(name = "user", value = "用户实体user", required = true, dataType = "User")
    })
    @RequestMapping(value = "user/{id}", method = RequestMethod.PUT)
    public ResponseEntity<JsonResult> update (@PathVariable("id") Integer id, @RequestBody User user){
        JsonResult r = new JsonResult();
        return ResponseEntity.ok(r);
    }


    @ApiIgnore//使用该注解忽略这个API
    @RequestMapping(value = "/hi", method = RequestMethod.GET)
    public String  jsonTest() {
        return " hi you!";
    }
}