HomeAboutMeBlogGuest
© 2025 Sejin Cha. All rights reserved.
Built with Next.js, deployed on Vercel
[팀]조규현 공간(1-2)
[팀]조규현 공간(1-2)/
🎫
인터파뀨/
🏷️
API 설계
🏷️

API 설계

API 설계
도메인
기능
HTTP verbs
Path
응답&요청
유저
공연
공연 공연 정보 조회
GET
/v1/performances
유저
공연
특정 공연 정보 조회
GET
/v1/performances/{performanceId}
유저
티켓
예매 티켓 등록
POST
/v1/tickets
유저
티켓
유저가 구매한 티켓 1개 상세정보 조회
GET
/v1/tickets/{ticketId}
유저
티켓
예매 티켓 결제 완료 상태로 변경
PATCH
/v1/tickets/{ticketId}/paymentStatus/completed
유저
티켓
특정 공연, 특정 날짜의 회차 정보 조회
GET
/v1/performances/{performanceId}/round?date=20220110
유저
티켓
특정 공연, 날짜, 회차의 회차 좌석 정보 조회
GET
/v1/performances/{performanceId}/round/{roundNumber}/seats?date=20220110
유저
회원 가입
POST
/v1/users
유저
회원 상세 정보 조회
GET
/v1/users/{userId}
관리자
공연
공연 정보 등록
POST
/admin/v1/performances
관리자
공연
공연 정보 수정
PUT
/admin/v1/performances/{performanceId}
관리자
공연
공연 정보 삭제
DELETE
/admin/v1/performances/{performanceId}

응답 포멧


{
  "common": {
		"message": "success",
		"requestUri": "/api/v1/users",
		"timestamp": "20211021212822",
		"internalHttpStatusCode": 200
  },
  "data": {}
}
 

참고 글

백엔드가 이정도는 해줘야 함 - 6. API 스펙 설계와 문서화 방식 결정 - (2)
API 스펙 설계가 끝났으니 이제 프론트엔드 팀에게 전해줄 문서를 작성해야 한다. 이거야 뭐 대충 마크다운같은 걸로 열심히 시간 쏟아서 정리해도 되는 부분이지만, 더 나은 방법이 없을지부터 고민해 보자. 이번 챕터에서는 API 문서화 방식 을 결정한다. 난 처음에 엑셀로 API를 문서화했다. 메소드 URI, 요청 파라미터, 응답 status code별 설명, 응답 body 등등을 컬럼으로 두고 내용을 채웠었다.
백엔드가 이정도는 해줘야 함 - 6. API 스펙 설계와 문서화 방식 결정 - (2)
https://velog.io/@city7310/%EB%B0%B1%EC%97%94%EB%93%9C%EA%B0%80-%EC%9D%B4%EC%A0%95%EB%8F%84%EB%8A%94-%ED%95%B4%EC%A4%98%EC%95%BC-%ED%95%A8-6.-API-%EC%8A%A4%ED%8E%99-%EC%84%A4%EA%B3%84%EC%99%80-%EB%AC%B8%EC%84%9C%ED%99%94-%EB%B0%A9%EC%8B%9D-%EA%B2%B0%EC%A0%95-2
백엔드가 이정도는 해줘야 함 - 6. API 스펙 설계와 문서화 방식 결정 - (2)
REST API 디자인 가이드
조대협(http://bcho.tistory.com) REST API 디자인을 보면, REST 사상에 맞춰서 제대로 디자인 (CRUD를 HTTP method에 맞춘)하기도 어렵고, URI Convention등이나 보안, 버전 관리등 고려할 사항이 많다. 이번 글에서는 REST API를 디자인에 대한 가이드를 소개하고자 한다. URL을 심플하고 직관적으로 만들자 REST API를 URL만 보고도, 직관적으로 이해할 수 있어야 한다URL을 길게 만드는것 보다, 최대 2 depth 정도로 간단하게 만드는 것이 이해하기 편하다.
REST API 디자인 가이드
https://bcho.tistory.com/914
REST API 디자인 가이드
REST API Documentation - CAFE24 REST API
API version: 2021-09-01 (latest) 카페24 쇼핑몰 API는 카페24 쇼핑몰에 연동하여 서비스를 제공하기 위한 앱스토어 입점 개발사, 서드파티 솔루션 제공자 등에 제공하는 API입니다. 카페24 API는 RESTful한 아키텍쳐로서 OAuth 2.0 기반의 인증 시스템과 표준 HTTP Request Method, 리소스를 예측할 수 있는 엔드포인트 URL, HTTP 코드 기반의 에러 메시지를 제공합니다.
REST API Documentation - CAFE24 REST API
https://developer.cafe24.com/docs/api/front/#products
REST API Documentation - CAFE24 REST API