개발문서 (1) 썸네일형 리스트형 [REST API] API 문서 작성 API 문서 작성 API 문서란? API 문서는 개발자와 사용자가 원활하게 API를 파악하고 사용할 수 있도록 돕는 문서다. API의 기능, 데이터 형석, 사용 방법, 오류와 같이 API를 사용하기 위해서 알아야하는 제약들을 명시한다. 좋은 내부 API에 문서는 개발이 원활히 진행될 수 있도록 도와준다. 고려해야 하는 사항 1. 출력 형식이 바뀌어도 쉽게 적응할 수 있어야 한다. 2. 작성하는 사람이 뭘 써야 하는지 쉽게 알 수 있어야 한다. 작성 방법 개발 시작 전 각 API의 기능, 이를 위해 사전에 필요한 사항, 주고받을 데이터 등이 포함된 API 문서 초안을 작성한다. 이를 통해 API 개발의 방향을 명확히 할 수 있으며, 문서 초안 공유 후 피드백을 받을 수도 있다. 포함되어야 하는 항목 개요 .. 이전 1 다음
