빠른 사용

Maven 프로젝트 종속성에 Swagger를 추가합니다.

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

Swagger 구성:

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    
    
  
    @Bean
    public Docket api() {
    
     
        return new Docket(DocumentationType.SWAGGER_2)  
          .select()                                  
          .apis(RequestHandlerSelectors.basePackage("com.example.demo"))              
          .paths(PathSelectors.any())                          
          .build();                                           
    }
}

이 예제에서는 com.example.demo 패키지에서 요청 핸들러를 스캔하고 모든 경로에 대해 Swagger 설명서를 활성화하도록 Swagger를 구성합니다.

API 인터페이스 및 작업 작성:

@RestController
@RequestMapping("/api")
public class UserController {
    
    
  
    @GetMapping("/users")
    public List<User> getUsers() {
    
    
        // 获取所有用户
    }
  
    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
    
    
        // 创建新用户
    }
  
    @GetMapping("/users/{id}")
    public User getUserById(@PathVariable(value = "id") long userId) {
    
    
        // 根据 ID 获取用户
    }
  
    @PutMapping("/users/{id}")
    public User updateUser(@PathVariable(value = "id") long userId, @RequestBody User userDetails) {
    
    
        // 更新用户信息
    }
  
    @DeleteMapping("/users/{id}")
    public void deleteUser(@PathVariable(value = "id") long userId) {
    
    
        // 删除用户
    }
}

이러한 작업은 사용자 관련 API 요청을 처리합니다.

애플리케이션을 시작하고 Swagger 인터페이스에 액세스합니다.

Spring Boot 애플리케이션을 시작합니다. 브라우저에 http://localhost:8080/swagger-ui.html URL을 입력합니다. Swagger UI 인터페이스가 표시됩니다. 여기에서 각 작업에 대한 세부 정보가 포함된 API 목록을 볼 수 있습니다.

추천