개발/Spring

API 문서의 필요성API 문서는 개발자들이 만들어 둔 API를 사용하여 서버의 비즈니스 로직과 데이터베이스에 접근할 때, API 사용 방법을 이해하고 다른 시스템과의 상호작용을 원활하게 하기 위해 필요하다. 이를 통해 효율적인 개발, 유지보수, 문제 해결이 가능해진다. 가장 잘 알려진 문서화 도구들은 REST API 개발 시에는 Swagger, GraphQL일 시에는 Playground 등이 있다. 스프레드시트 등 수동 작성에 비교해 보았을 때 생산성 있고, 자동화된 형태의 문서를 생성할 수 있다는 장점이 있다.  Swagger란?Swagger는 OpenAPI Specification을 기반으로 한 도구 모음으로, REST API를 설계, 빌드, 문서화, 소비할 수 있게 돕는다. 주요 도구로는 Swag..