Swagger - spring 기초 적용

요한·2025년 7월 20일

Swagger

Swagger란

Swagger에서 제공하는 오픈소스와 전문가용 도구로 API 문서를 쉽게 만들 수 있어 , 당신과 팀이 API를 효율적으로 설계하고 문서화하는 데 도움이 된다고 하네요.

위에 이미지 오른쪽 부분에 옛날에 공공데이터 사용할때 본거 같은데 친숙하네요 ㅎㅎ

사용 이유

위에 저의 하찮은 영어 실력이유가 설명이 조금 되었지만 back-end 와 front-end가 서버를 따로 두는 경우가 있어 프로젝트 협업이 전보다는 구체적으로 api 명세서가필요한 경우가 있다. 이처럼 swagger를 사용하게 되면 편리하게 api 명세서를 확인 할 수 있다. 서로 winwin ㅎㅎ

사용법

조금 힘들지만 공식 문서 보고 적용해보겠습니다!

0. https://springdoc.org/ <- 접속

1. 소개

swagger 사용처가 여기 나와있네요 .. 한참을 찾았네

2. 설정

maven

<!-- https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.8.9</version>
</dependency>

gradle

// https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui
implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.9")

gradle은 안보여서 mavenRepository에서 가져왔습니다.

properties

4-7

여기에 apiResponse 있는거보면 이거인거같은데 RouterOperation도 있고 한번해보면 알겠네요... 해봅시다

method

@GetMapping("/hello")
    @Operation(summary  = "한눈의 들어오는 한줄요약 느낌 ?",description = "간단한 설명")
    public HttpEntity<String> helloGet() {
        return new HttpEntity<>("hello");
    }