프론트엔드 백엔드 개발자 간 소통돕는 Swagger

Swagger는 API를 문서화하고 시각적으로 표현할 수 있는 오픈 소스 도구이자 프레임워크입니다. 주로 RESTful API를 문서화하고 사용자가 API 엔드포인트, 요청 및 응답 형식, 매개변수, 헤더 등을 쉽게 이해하고 테스트할 수 있도록 도와줍니다. Swagger는 API 개발 과정을 효과적으로 관리하고 팀 간의 협업을 강화하는 데 도움이 됩니다.

Swagger를 사용하면 다음과 같은 기능을 제공합니다:

1. 문서화: API의 엔드포인트, 메서드, 매개변수, 응답 형식 등을 자동으로 문서화하여 API를 쉽게 이해할 수 있게 합니다.
2. 시각화: Swagger UI를 통해 사용자가 API를 시각적으로 탐색하고 테스트할 수 있습니다.
3. 테스트: Swagger UI에서 직접 API를 테스트할 수 있어, API 개발자나 소비자가 실제 요청 및 응답을 쉽게 확인할 수 있습니다.
4. 코드 생성: Swagger 문서를 기반으로 클라이언트 또는 서버 코드를 자동으로 생성할 수 있습니다.
5. 모의 서비스: Swagger를 사용하여 API의 모의 서비스를 생성하여 개발자가 실제 서버 없이도 클라이언트를 테스트할 수 있게 합니다.

API 개발자가 Swagger를 사용하면 API 변경 사항을 쉽게 추적하고 관리할 수 있으며, 사용자가 정확한 정보를 얻을 수 있도록 도움이 됩니다. Swagger는 Swagger Editor, Swagger UI 등의 도구로 제공되며, OpenAPI Specification(이전 명칭은 Swagger Specification)을 따라 API를 설명합니다. OpenAPI Specification은 API 설계를 위한 강력한 표준입니다.

 

ex) ex2에 백단 서버 배포해서 링크 타면 swagger  문서화 되도록 만들었습니다. 

 

 

스타트업에서 서버 개발자로 일하면서, 불편한 점을 하나씩 해결하고자 노력하고 있습니다. 그중, 하나가 API 명세서 작성에 관한 부분이었습니다. 처음 팀에 합류하고 API 개발을 위해 명세를 찾아봤지만, 제대로 정리된 명세서를 찾아볼 수 없었습니다. 수많은 API가 있었지만, 명세가 없어서 API를 수정하거나, 생성할 때 수많은 시간이 걸렸습니다. 반드시 API 명세서를 제대로 작성해서 업무에 적용시켜야겠다고 생각했습니다. 수많은 삽질을 하면서 swagger를 활용해서 명세를 작성하는 것이 가장 효율적이라고 생각했습니다. node.js를 활용한 swagger 적용 삽질기에 대해 작성하겠습니다. 

 

출처: https://overcome-the-limits.tistory.com/101 [Plus Ultra:티스토리]

 

브라우저에서 url로 열어서 api 문서 볼 수 있는 거 맞는 정보다. 커뮤니티에서도 확인함.