일반 API 개발 도구 Swagger

Swagger는 API 개발자를 위한 도구 모음이며, OpenAPI Specification을 기반으로 합니다⁴.

이는 REST API를 설명하는 언어에 구애받지 않는 명세로, 소스 코드에 직접 접근하지 않고도 컴퓨터와 사람 모두가 REST API의 기능을 이해할 수 있게 해줍니다³.

Swagger의 주요 목표는 다음과 같습니다³:

• - 분리된 서비스를 연결하는 데 필요한 작업을 최소화합니다.
• - API를 문서화하고 빠르게 명세할 수 있습니다.
• - 작성된 문서를 통해 SDK를 생성하여 빌드 프로세스를 간소화할 수 있습니다.
• - 작성된 API를 시각화합니다.
• - API를 시각화하고 빠른 테스팅을 진행할 수 있습니다.

Swagger는 다음과 같은 주요 도구를 제공합니다¹²:

• - **Swagger Editor**: API를 문서화하고 빠르게 명세할 수 있습니다.
• - **Swagger Codegen**: 작성된 문서를 통해 SDK를 생성하여 빌드 프로세스를 간소화할 수 있습니다.
• - **Swagger UI**: 작성된 API를 시각화합니다.
• - **Swagger Inspector**: API를 시각화하고 빠른 테스팅을 진행할 수 있습니다.

이러한 도구들은 API 개발을 단순화하고, 사용자, 팀, 그리고 기업이 API를 설계하고 문서화하는 데 도움이 됩니다¹.

출처: Bing과의 대화, 2024. 1. 19.

(1) Swagger (software) - Wikipedia. https://en.wikipedia.org/wiki/Swagger_%28software%29.

(2) ASP.NET Core web API documentation with Swagger / OpenAPI. https://learn.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?view=aspnetcore-8.0.

(3) API Documentation & Design Tools for Teams | Swagger. https://swagger.io/.

(4) [Spring]Spring Swagger 사용법 정리(API 문서 자동화하기) : 네이버 블로그. https://m.blog.naver.com/hj_kim97/222652876898.

(5) Swagger 란 무엇이며 사용 방법 | AppMaster. https://appmaster.io/university/ko/tutorials/endpoints/swagger-ran-mueosimyeo-sayong-bangbeob.

(6) undefined. https://velog.io/@mbsik6082/Spring-Boot-2.6.2에-Swagger-적용-시-오류.

(7) undefined. https://jackyee.tistory.com/24.

(8) undefined. https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter.