springboot结合swagger生成接口文档

原文链接:https://www.cnblogs.com/xu-lei/p/7423883.html

https://www.jianshu.com/p/b9ae3136b292

前后台分离的开发渐渐已成趋势。那么前后端的沟通就成了问题，包括移动端，web端。如果有一个东西在我们写完代码的时候，自动将接口的所有注释，调用文档提供出来，是不是一件很美好的事情。那就是使用swagger.

1.使用swagger,首先在pom中引入jar依赖。

<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中引入@EnableSwagger2来启动swagger注解

@Configuration

@SpringBootApplication // 组件扫描

@EnableScheduling

@EnableAsync

@EnableSwagger2

public class Application {

3.配置swagger的基本信息

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;

/**

 * @author 小尘哥

 * api 地址：http://localhost:9090/swagger-ui.html

 */

@Configuration

public class SwaggerConfig {

    @Bean

    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo())

                .select()

                .apis(RequestHandlerSelectors.basePackage("com.mos.eboot.service"))

                .paths(PathSelectors.any())

                .build();

    }

    private ApiInfo apiInfo() {

        return new ApiInfoBuilder()

                .title("eboot-api文档")

                .description("更多信息，请访问https://www.jianshu.com/u/3979cb11f079")

                .termsOfServiceUrl("https://gitee.com/QuanZhanZhiLu/easy-boot")

                .version("1.0")

                .build();

    }

}

4.使用接口注解

@RestController

@RequestMapping("/user")

@Api("userController相关api")

public class UserController {

    @Autowired

    private UserService userService;

//    @Autowired

//    private MyRedisTemplate myRedisTemplate;

    @ApiOperation("获取用户信息")

    @ApiImplicitParams({

        @ApiImplicitParam(paramType="header",name="username",dataType="String",required=true,value="用户的姓名",defaultValue="zhaojigang"),

        @ApiImplicitParam(paramType="query",name="password",dataType="String",required=true,value="用户的密码",defaultValue="wangna")

    })

    @ApiResponses({

        @ApiResponse(code=400,message="请求参数没填好"),

        @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")

    })

    @RequestMapping(value="/getUser",method=RequestMethod.GET)

    public User getUser(@RequestHeader("username") String username, @RequestParam("password") String password) {

        return userService.getUser(username,password);

    }

//    @RequestMapping("/testJedisCluster")

//    public User testJedisCluster(@RequestParam("username") String username){

//        String value =  myRedisTemplate.get(MyConstants.USER_FORWARD_CACHE_PREFIX, username);

//        if(StringUtils.isBlank(value)){

//            myRedisTemplate.set(MyConstants.USER_FORWARD_CACHE_PREFIX, username, JSON.toJSONString(getUser()));

//            return null;

//        }

//        return JSON.parseObject(value, User.class);

//    }

}

说明：

• @Api：用在类上，说明该类的作用
• @ApiOperation：用在方法上，说明方法的作用
• @ApiImplicitParams：用在方法上包含一组参数说明
• @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
  • paramType：参数放在哪个地方
    • header-->请求参数的获取：@RequestHeader
    • query-->请求参数的获取：@RequestParam
    • path（用于restful接口）-->请求参数的获取：@PathVariable
    • body（不常用）
    • form（不常用）
  • name：参数名
  • dataType：参数类型
  • required：参数是否必须传
  • value：参数的意思
  • defaultValue：参数的默认值
• @ApiResponses：用于表示一组响应
• @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
  • code：数字，例如400
  • message：信息，例如"请求参数没填好"
  • response：抛出异常的类
• @ApiModel：描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
  • @ApiModelProperty：描述一个model的属性

5.启动服务，浏览器输入"http://localhost:8080/swagger-ui.html"