Spring Boot 整合Swagger

embedded/2024/9/25 0:29:32/

一、引入依赖

二、自定义配置类

三、写一个测试的controller

四、正常使用接口测试工具测试

五、使用 Swagger 访问接口

一、引入依赖

     <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency>

二、自定义配置类

java">package com.beiyou.config;import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;import java.util.ArrayList;@Configuration
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket docket(Environment environment){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(true)//关闭swagger,默认是true.select()//RequestHandlerSelectors：配置要扫描的方式，有basePackage("路径")、any():扫描全部，none():全部不扫描//RequestHandlerSelectors.withMethodAnnotation():扫描方法上的注解//.withClassAnnotation()：扫描类上的注解.apis(RequestHandlerSelectors.basePackage("com.beiyou"))//指定扫描的包.paths(PathSelectors.ant("/**"))//设置请求路径，这里是带有hello的请求路径.build() ;}private ApiInfo apiInfo(){//  Contact contact = new Contact("黑米", "https://blog.csdn.net", "xxx@qq.com");return new ApiInfo("商品组的Api","请老大检阅","v2.0","https://www.baidu.com",null,"Apache 2.0","http://www.apache.org/licenses/LICENSE-2.0",new ArrayList());}}

三、写一个测试的controller

java">/** Copyright (c) 2020, 2024, webrx.cn All rights reserved.**/
package com.beiyou.controller;import org.springframework.web.bind.annotation.*;@RestController
@RequestMapping("/api/product")
public class TestController {@GetMappingpublic String test() {return "查询商品成功";}@PostMappingpublic String test2() {return "添加商品成功";}@PutMappingpublic String test3() {return "修改商品成功";}@DeleteMappingpublic String test4() {return "删除商品成功";}
}