전체 구성

• 내용
  • API 문서를 작성하는 페이지를 제공합니다.
• Request/Response DTO
  • 각각의 Request, Response DTO를 설정합니다.
  • DTO들은 별도의 페이지로 관리합니다.
• 유형
  • 메서드를 지정합니다.
  • 자세한 메서드 지정에 대한 내용은 RESTful한 API 생성하기 파트를 참고해주세요.
• Path
  • Base URL 뒤에 붙을 path를 작성해주세요.
  • 자세한 Path 지정에 대한 내용은 RESTful한 API 생성하기 파트를 참고해주세요.
• 진행상태
  • 현재 문서 작성 또는 구현 진행상태를 작성해주세요.
  • 상태별 설명
    • 시작 전: 문서 작성 전
    • 문서 작성 중: 현재 작성된 문서를 수정하고 있는 경우
    • 문서 리뷰 중: 현재 작성한 문서에 대한 리뷰를 진행하고 있는 경우
    • 진행 중: 문서 작성이 완료되어 개발을 진행하고 있는 경우
    • 리뷰 중: 개발 사항에 대한 리뷰를 진행하고 있는 경우
    • 완료: API 개발이 완료된 경우
• 설명
  • 해당 API에 대한 간단한 설명을 작성해주세요.
• 구현 담당자
  • 해당 API의 구현 담당자(FE, BE 모두)를 지정해주세요.

API 상세 설명 문서 작성하기

Request

• Access Token: 필요한 경우에만 사용
• Path Parameter: Path 파라미터에 대한 내용을 작성합니다
• Query Parameter: 쿼리문으로 보낼 파라미터에 대한 내용을 작성합니다.
• Request Body: 보낼 Request DTO를 페이지로 멘션해주세요.
  • DTO 문서 작성법은 아래 문서를 참고해주세요.