Spring Boot 配置 Swagger2 - 详细步骤与示例代码

要在 Spring Boot 中配置 Swagger2，需要执行以下步骤：\n\n1. 添加 Swagger2 依赖：在 pom.xml 文件中添加以下依赖：\n\nxml\n<dependency>\n <groupId>io.springfox</groupId>\n <artifactId>springfox-swagger2</artifactId>\n <version>2.9.2</version>\n</dependency>\n<dependency>\n <groupId>io.springfox</groupId>\n <artifactId>springfox-swagger-ui</artifactId>\n <version>2.9.2</version>\n</dependency>\n\n\n2. 创建 Swagger2 配置类：创建一个类，并使用@Configuration和@EnableSwagger2注解将其标记为配置类，并实现WebMvcConfigurer接口。\n\njava\n@Configuration\n@EnableSwagger2\npublic class SwaggerConfig implements WebMvcConfigurer {\n\n @Bean\n public Docket api() {\n return new Docket(DocumentationType.SWAGGER_2)\n .select()\n .apis(RequestHandlerSelectors.basePackage("com.example.controller"))\n .paths(PathSelectors.any())\n .build();\n }\n\n @Override\n public void addResourceHandlers(ResourceHandlerRegistry registry) {\n registry.addResourceHandler("swagger-ui.html")\n .addResourceLocations("classpath:/META-INF/resources/");\n\n registry.addResourceHandler("/webjars/**")\n .addResourceLocations("classpath:/META-INF/resources/webjars/");\n }\n}\n\n\n其中，api()方法用于配置 Swagger 的基本信息，如扫描的包、API 路径等。addResourceHandlers()方法用于配置 Swagger UI 的资源路径。\n\n3. 配置 Swagger 的访问路径：在application.properties文件中添加以下配置：\n\n\n# Swagger\nswagger.enabled=true\n\n\n这将启用 Swagger，并将其默认配置应用于应用程序。\n\n4. 启动应用程序并访问 Swagger UI：启动应用程序后，可以通过访问http://localhost:8080/swagger-ui.html来查看生成的 API 文档。\n\n以上是在 Spring Boot 中配置 Swagger2 的基本步骤。你可以根据自己的需要进行进一步的配置和定制化。