현대 개발 워크플로우에서 API 문서화 도구 시작하기

Source: Dev.to

Introduction

안녕하세요 여러분 👋

저는 현재 마이크로서비스와 외부 연동을 포함한 현대 개발 워크플로우에서 API 문서화와 테스트를 위한 다양한 도구와 접근 방식을 탐색하고 있습니다.

Background

초급/중급 개발자로서 API 문서가 자주:

• 금방 오래됨
• 실제 테스트와 연결되지 않음
• 팀 간 유지 관리가 어려움

이라는 점을 느꼈습니다. 그래서 실제 현업 팀들이 이 문제를 어떻게 해결하고 있는지 이해하려고 노력하고 있습니다.

지금까지 본 일반적인 접근 방식은 다음과 같습니다:

• OpenAPI / Swagger 기반 문서화
• 테스트와 문서를 위한 별도 도구
• 두 워크플로우를 모두 결합하려는 통합 플랫폼

제가 조사하면서 발견한 도구 중 하나는 Apidog으로, API 설계, 테스트, 문서를 하나의 워크플로우에서 결합합니다. 특히 작은 팀에서 모든 것을 동기화하는 데 흥미로워 보입니다.

Questions for the Community

• 프로젝트에서 API 문서는 무엇을 사용하고 계신가요?
• API가 진화함에 따라 문서를 최신 상태로 유지하려면 어떻게 하시나요?
• 시작하는 분들에게 추천할 만한 도구나 워크플로우가 있나요?

경험을 공유해 주셔서 미리 감사드립니다.