Goal

프론트에 제공할 API Docs를 Swagger로 내보내기 이전에, 서버 측 개발을 위한 각 API 별 요구사항들을 구체적으로 명시하는 용도로 문서화한 공간입니다.

API 의 구체적인 내용은, 데이터베이스의 각 API 페이지를 클릭하면 다음과 같은 예시처럼 확인할 수 있습니다.

Convention

/api/{version 정보: v1}/{domain}/{action}

Example

AUTH-1: 회원가입

Property Value
API Path /api/v1/auth/register
HTTP Method POST
Authorization None
Content-Type application/json

Description

Request

Response

Constraints

Completion Conditions