API 문서 만들기

🙄 API 문서를 만드는 건 생각보다 간단하지 않다!
API 문서를 만드는 것이 프로젝트 전체의 뼈대를 잡는 것과 같기 때문이다!

실제로 화면을 보고 어떤 데이터가 필요할 지 고민하는게 바로 서버 파트의 역할이다 !

💡 와이어 프레임을 보고 데이터를 설계할 수 도 있다.

1. url path 입력

클라이언트가 어떤 주소 , 어떤 메서드로 접근할지 적어준다.

2. Request 형식 써주기

• Request-Header
• Request-Params
• Request-Body
• Response-Body

3. 성공, 실패 예시 보여주기

postman에서 나온 결과를 복붙해주면 된다 !

Postman?

API Test를 조금 더 간편하고 쉽게 만들어주고 보기에도 좋게 활용할 수 있는 툴이다.
테스트하는 기능뿐만 아니라 Postman에서 API 문서 작성을 위한 기능이 있다고 한다.
Postman으로 API문서 만들기