# Spring boot(maven) - Swagger로 내가 만든 API 관리를 편하게 해보자.

일단 나는 springboot에 maven 환경이다.

그래서 gradle은 gpt한테 아래 코드를 gradle로 바꿔달라하면 잘 알려줄것이다.

 

1.pom.xml 추가

<dependencies>
...
</dependencies> 아래에

<!-- # 중앙 저장소(repository) 명시적으로 추가 -->
	<repositories>
		<repository>
			<id>central</id>
			<name>Maven Central Repository</name>
			<url>https://repo1.maven.org/maven2</url>
		</repository>
	</repositories>

<!-- # Swagger (springdoc-openapi-ui) -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.3.0</version>
</dependency>

혹시 이걸 입력했을때 못찾고 에러가 뜬다면

중앙저장소를 못찾는거라서 위 코드를 추가해주고 reload 해주면 정상적으로 가져와질것이다.

 

2. application.properties 추가

# Swagger UI
springdoc.api-docs.path=/v3/api-docs
springdoc.swagger-ui.path=/swagger-ui.html

 

기본 path는 원하는대로 해주면 된다.

나는 swagger-ui.html로 설정했기때문에

http://localhost:8080/swagger-ui/index.html로 접속하면 

 

이런식으로 정리된 사이트가 나타난다.

 

참고로

 

try it out버튼을 누르면 여기서 직접 테스트도 해볼수 있어서 너무 좋은것같다.

 

각각의 제목이나 설명도

컨트롤러에

@Operation(summary = "업데이트", description = "유저 업데이트")
@PostMapping("/update")

이런식으로 써놓으면

설명도 함께 추가되서 협엽할때 아주 유용할 것 같다.