api문서화1 Swagger와 drf-yasg (API 문서 자동화 도구) 00 API 문서화 개요 1. API 문서화의 중요성 1) 배경 구두/수기로 작성한 문서로 주고 받기에는 불편함이 많음 개발 작업 특성상 서로간 공유해야하는 수많은 내부 요소들이 있고, 이 중 하나라도 누락이 되면 정상 기능을 방해하는 오류 발생 이런 불편함을 해소하고자 API를 자동으로 문서화 할 수 있는 방안 고안 API 문서화 도구: 서로의 통신 내용을 직관적으로 파악할 수 있게끔하는 웹 개발자의 필수 보조 작업물 2) API 문서화란 백엔드가 작성한 각각의 API 기능을 문제없이 사용하기 위해서, 개발자 간 어떠한 구성 요소를 주고 받아야하는지 분명/뚜렷하게 정리하는 작업 2. API 문서화의 장점 1) 개인의 장점 자신의 작업물을 다른 사람과 효율적으로 공유 가능 API 기능 정의서에는 목적, .. 2024. 3. 26. 이전 1 다음