728x90
api 문서
-
Spring Boot - Swagger 라이브러리를 활용하여 API 문서 자동화하기Framework & Library/Spring Boot 2023. 1. 19. 17:32
Swagger 라이브러리를 활용하여 API 문서 자동화하기 Swagger란? API 문서는 API 사용 방법을 사용자에게 알려주는 문서이다. API를 잘 사용하기 위해서는 API 문서를 잘 활용해야 한다. API 문서에는 아래와 같은 정보들이 포함된다. 1. 요청 URL 2. 해당 API에 대한 설명 3. 헤더 정보 4. 요청 파라미터 5. 응답 데이터 6. 요청 파라미터와 응답 데이터에 대한 설명 7. API 호출에 대한 응답 샘플 등 위와 같은 정보들을 제공해 주는 문서는 잘 설명되어 있어야 사용자들이 문의 없이 API를 잘 사용할 수 있을 것이다. 또한 MAS에서는 API로 주로 통신하기 때문에, 문서화가 잘 되어 있어야 한다. API 문서는 중요하지만, API 스펙을 하나의 문서로 관리하는 것은 ..