Flask, marshmallow, apispec으로 API 문서화 자동화하기

0 명세 기반의 API 문서를 자동화하는 경험을 공유합니다. 과거 풀스택 개발 문화에서 별도의 API 문서가 없었던 스포카는 개발자 분업화에 따라 프론트엔드와 백엔드 개발자 간의 효율적인 소통을 위해 고도화된 API 문서의 필요성을 느꼈습니다.

필자는 OpenAPI Specification(OAS)을 활용하여 API 문서 작성의 효율성을 높이는 방법을 모색했으며, marshmallow를 통해 데이터 유효성 검증 스키마를 정의하고 apispec을 사용하여 이를 기반으로 OpenAPI 문서를 자동으로 생성하는 과정을 설명합니다. 이를 통해 API 문서의 일관성을 유지하고 개발 생산성을 향상시킬 수 있습니다.

동으로 생성하는 과정을 설명합니다. 이를 통해 API 문서의 일관성을 유지하고 개발 생산성을 향상시킬 수 있습니다.