[Springboot] API Docs (Swagger3, Springdoc) (1)

1. pom.xml - dependency 추가 (버전은 알아서..)

		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-openfeign</artifactId>
			<version>4.0.3</version>
		</dependency>

참고 : https://springdoc.org/

OpenAPI 3 Library for spring-boot

 

3. application.yml - springdoc 설정

 

springdoc:
  api-docs:
    groups:
      enabled: true
  swagger-ui:
    path: /swagger-ui.html
    display-request-duration: true
    groups-order: DESC
    operationsSorter: method
    disable-swagger-default-url: true
  show-actuator: true
  group-configs:
    - group: sample
      paths-to-match: /**/sample/**

springdoc에 대한 설정은 application.yml 파일에서 할 수 있다. swagger-ui를 실행시키는데 필요한 path 정보 및 동작시킬 api들에 대해서 정의를 할 수 있다.

​

3. SampleController.java

 

@Slf4j
@RequestMapping("/sample")
@RestController
public class SampleController {
    
    @GetMapping("/test1")
    public Json<List<TestVo>> test1() {
        log.debug("test1");
        return null;
    }
    @GetMapping("/test2")
    public Json<List<TestVo>> test2() {
        log.debug("test2");
        return null;
    }
}

 

4. Swagger 접속​

http://localhost:port/swagger-ui/index.html