springboot引入swagger-ui
阿新 • • 發佈：2021-12-06
1.依賴
4.在Controller類上標註註解
2.配置 application.yml<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency>
# swagger 開關
swagger:
enable: true3.配置類 Swagger2
點選檢視程式碼
import org.springframework.beans.factory.annotation.Value; 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.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class Swagger2 { // swagger開關 @Value("${swagger.enable}") private boolean swaggerEnable; @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .enable(swaggerEnable) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.pingan.controller")) // swagger掃描指定包下面的介面 .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { Contact contact = new Contact("ex-laiqiaobo001","http://127.0.0.1:8001(隨便或者網站地址)","[email protected]"); return new ApiInfoBuilder() .title("這個是swagger的標題") .description("這個是副標題") .contact(contact) .version("1.0") .build(); } }
@Api(tags = "學生操作") @RestController @RequestMapping("/student") public class StudentController { private static final Logger log = LoggerFactory.getLogger(StudentController.class); @Autowired private StudentService studentService; @ApiOperation(value="查詢使用者", notes="查詢所有使用者") @GetMapping("/test") public String test() { log.info("-----------------這個是好事----------------------------"); return "aaaaaaaaaaa"; } }
-@Api()用於類；
表示標識這個類是swagger的資源 例: @Api(tags = "學生操作") -@ApiOperation()用於方法； 表示一個http請求的操作 例: @ApiOperation(value="查詢使用者", notes="查詢所有使用者") -@ApiIgnore()用於類，方法，方法引數 表示這個方法或者類被忽略 5.訪問對應的ip和埠: http://127.0.0.1:xxxx/swagger-ui.html/ 6. 經過上面的步驟後，再引入下面的依賴，則可以訪問新的swagger-ui介面 http://127.0.0.1:xxxx/doc.html<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>