springboot集成swagger2

来源:互联网 发布:北京数据分析师招聘 编辑:程序博客网 时间:2024/05/15 08:08

1、添加pom.xml

 <!-- Swagger -->        <dependency>            <groupId>io.springfox</groupId>            <artifactId>springfox-swagger2</artifactId>            <version>2.6.1</version>        </dependency>        <dependency>            <groupId>io.springfox</groupId>            <artifactId>springfox-swagger-ui</artifactId>            <version>2.6.1</version>        </dependency>

2、编写Swagger配置文件

@Configuration@EnableSwagger2public class SwaggerConfig {    @Bean    public Docket createRestApi()    {        return new Docket(DocumentationType.SWAGGER_2)                .apiInfo(apiInfo())                .select()                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))                .paths(PathSelectors.any())                .build();    }    private ApiInfo apiInfo() {        return new ApiInfoBuilder()                .title("测试项目 APIs")                .description("测试项目 API")                .termsOfServiceUrl("www")                .contact("hshk")                .version("1.0")                .build();    }}

3、在Controller里添加Swagger注解
常用swagger注解

@ApiOperation:用在方法上,说明方法的作用    value: 表示接口名称    notes: 表示接口详细描述 @ApiImplicitParams:用在方法上包含一组参数说明@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面paramType:参数位置header 对应注解:@RequestHeaderquery 对应注解:@RequestParampath  对应注解: @PathVariablebody 对应注解: @RequestBody

demo:
这里写图片描述
经过上面的配置 就集成完了,使用http://127.0.0.1:8083/swagger-ui.html访问
这里写图片描述

原创粉丝点击