<aside> 📎 api 명세서 예시 https://developers.kakao.com/docs/latest/ko/kakaotalk-social/rest-api api에 대한 간단한 설명 https://blog.wishket.com/api란-쉽게-설명-그린클라이언트/ restful api https://velog.io/@somday/RESTful-API-이란

</aside>

규칙

모든 API 요청을 전송하는 기본 URL은 https://{미정}/api입니다. (배포 이후에 기본 URL을 수정합니다.)

API 문서 작성 가이드

엔드포인트

API 문서

<aside> 📍

🔴: private DTO

🟢: public DTO(Response)

</aside>

Response DTO

Request DTO

Exception Table

각 서비스 별로 발생할 수 있는 에러에 대한 Http Code, 커스텀 에러 코드를 정의합니다.

각 패키지에 ApiException을 상속한 개별 Exception 클래스를 정의하고, 그에 대응하는 errorCode를 명시합니다.

새로운 errorCode는 커스텀 코드, 메시지, httpCode를 포함하여 정의합니다.

Exceptions