API 문서1 Postman API를 통한 API 문서 작성 백엔드 담당으로 팀 프로젝트를 담당하다보면 api를 만들고 프론트한테 api에 대한 것들을 설명해야 할 경우가 많다. 항상 노션이라던가 구두로 이건 어떻게 저건 어떻고 등 설명을 해왔는데 시간도 오래걸리고 프론트단이 한번에 이해못하는 경우가 많았다. 이를 어떻게 해야하나 고민하던 도중 'API문서'라는 것을 알게되었고 적용한 내용을 작성해보고자 한다. 어떤 api는 body안에 어떤 데이터를 제공해야하고 헤더는 어떻고 queryString과 pathVariable은 어떤지, 더욱이 response때 데이터나 헤더는 어떤지 API 유형은 어떤지 등 프론트 단에서는 모든 정보가 다 궁금할 것이다. 정보를 확실히 알아야 적용을 할 수 있으니까 말이다. 그렇기에 백엔드 단에서는 정보들을 문서화에서 제공을 해주는.. 2023. 3. 12. 이전 1 다음
