Springfox 기본 구성

Springfox는 오픈 소스 UI(사용 가능한 인터페이스)를 사용하여 Spring Boot와 통합할 수 있으며 Swagger를 구체적으로 설명하고 API Rest에 대한 문서를 제공합니다.

프로젝트 링크: Springfox

Antes de prosseguirmos fica uma observação.
2.4.X 버전의 Spring Boot는 Spring Boot 클래스 구성에 @EnableWebMvc 주석이 필요하며, Springfox 클래스는 mainApp 클래스에 있어야 합니다. 예를 들면 다음과 같습니다.

초기에는 프로젝트 번호Spring Initialize가 있으며 Spring Web에 종속되어 있습니다.

Springfox가 pom.xml에 종속된 IDE 프로젝트를 가져오려면 다음을 수행하십시오.

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

Swagger에서 UI를 구성하는 클래스는 Swagger에서 클래스를 정의하고 UI를 정의할 수 있도록 하며, @EnableWebMvc에서 최신 정보를 얻을 수 있습니다.

@EnableWebMvc
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket swagger() {
        return new Docket(DocumentationType.SWAGGER_2).select()
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.any())
                .build();
    }
}

Crie um controller com os verbos HTTP de example.

@RestController
@RequestMapping("/exemplo")
public class ExemploController {

    @GetMapping
    public String getExemplo() {
        return "Retorno exemplo";
    }

    @PostMapping
    public void postExemplo() {
    }

    @PutMapping
    public void putExemplo() {
    }

    @DeleteMapping
    public void deleteExemplo() {
    }
}

애플리케이션 시작, 액세스http://localhost:8080/swagger-ui/index.html



Springfox의 기본 구성을 제공하고 Spring Boot를 통합하여 API Rest의 엔드포인트에서 UI를 표시합니다.