java swagger 引入和配置

在Java项目中集成Swagger用于生成API文档，你需要按照以下步骤进行：

1. 引入依赖

首先，在你的pom.xml文件中添加Swagger的相关依赖。这里以Springfox Swagger 3.0.0为例（请根据实际需要选择合适版本）：

xml

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

如果你需要使用旧版Swagger UI，可以添加以下依赖：

xml

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

2. 配置Swagger

创建一个配置类，通常命名为SwaggerConfig，并使用@EnableSwagger2WebMvc或@EnableOpenApi（针对Springfox 3.0.0及以上版本）注解来启用Swagger配置。例如：

java

import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                // 选择哪些控制器生成文档
                .apis(RequestHandlerSelectors.any())
                // 匹配所有路径
                .paths(PathSelectors.any())
                .build();
    }
}

3. 使用Swagger注解

在你的API控制器类上使用@Api注解，为每个API方法使用@ApiOperation，以及其他相关的注解如@ApiParam, @ApiResponses等来提供详细的文档信息。例如：

java

import io.swagger.annotations.*;

@Api(value = "用户管理", description = "用户管理相关接口")
@RestController
@RequestMapping("/users")
public class UserController {

    @ApiOperation("获取用户信息")
    @GetMapping("/{id}")
    public User getUser(@ApiParam(value = "用户ID", required = true) @PathVariable Long id) {
        // ...
    }

    // 其他方法...
}

4. 静态资源映射

确保你的应用能够正确地映射Swagger UI的静态资源。在Spring Boot中，你可能需要在WebSecurityConfigurerAdapter的configure(HttpSecurity http)方法中添加如下代码，以便在未登录时也能访问Swagger UI：

java

http.authorizeRequests()
    .antMatchers("/swagger-ui/**").permitAll()
    .and()
    // 其他安全配置...

5. 启动应用

完成上述配置后，启动你的应用。Swagger UI通常可以通过http://localhost:8080/swagger-ui/（替换为你的应用端口）来访问。

请注意，Swagger的配置可能会因版本不同或具体需求而有所变化，确保查阅官方文档或最新版本的指南以获取最准确的信息。

5

58139685@163.com

今天 11:22

java swagger 引入和配置