API 작성 가이드라인 문서는 어떻게 만들까요?

Question

다들 백엔드 팀 내에서 API 작성 가이드라인에 대한 공식적인 문서들이 있는지 궁금합니다.

있다면 어떤 내용들을 주로 담고 있는지도 여쭤보고 싶어요!

백엔드 개발팀을 위한 API 작성 가이드라인 문서를 만드려고 하는데 감이 잘 잡히질 않네요ㅠ

각 팀원들의 작성 시나리오들을 참고해야할까요? 참고할만한 자료들이 있다면 공유 부탁드립니다!

손정현 · Answer

안녕하세요!

저라면 우선 사내 각 팀들이 어떻게 작성하고 있는지 확인해볼 것 같아요. 기존에 사용하고 있던 방식이 있다면 그걸 기반으로 시작할 것 같네요.

API 작성 가이드라인은 어느 회사나 고민하는 부분이기 때문에 잘 찾아보시면 좋은 레퍼런스 많을것 같습니다.

어떤 API를 작성하시는지는 잘 모르겠지만 REST라면 저는 마이크로소프트 문서를 많이 참고했습니다. 한번 훑어보시면 도움이 되실 것 같아요 :)
- https://learn.microsoft.com/en-us/azure/architecture/best-practices/api-design