목차
1.
3.
1. 개요
•
API 문서는 개발자와 사용자가 원활하게 API를 파악하고 사용할 수 있도록 돕는 문서이다.
•
API 문서는 API의 기능을 분명하게 명시하고, 사용 방법과 관련 오류를 살펴 볼 수 있게 해야 한다.
2. 작성 시 고려 사항
•
개발을 시작하기 전에 문서를 작성하기
◦
해당 API가 어떤 기능을 할 것이며 이를 위해 사전에 필요한 사항들을 정리하면서 API 개발의 방향을 명확히 할 수 있다.
•
문서를 읽는 대상자를 고려하기
◦
사용자가 원하는 정보를 정확하게 얻을 수 있도록 해야 한다.
◦
필수적인 정보들을 정확하게 담되 가능한 쉬운 용어를 사용하는 것이 좋다.
•
예시를 포함하기
◦
응답 성공 예시와 에러 예시를 첨부하고 에러는 문서가 너무 길어지는 것을 고려해 가장 대표적인 에러들만 첨부하는 것이 좋다.
•
지속적으로 업데이트 하기
◦
API 문서는 한 번 작성하면 마무리 되는 작업이 아닌 수정과 같은 피드백을 반영하여 계속해서 문서를 업데이트 해야 한다.
3. 작성 도구
•
현재 postman에서 진행
•
변경할 작성 도구
◦
swagger
•
시연 예정
참고 자료
