🧾
API 명세서를 만들어보자!
알림(Notification) 시스템 API 명세서 및 아키텍처 목차 개요 시스템 아키텍처 ERD 구조 API 명세서 이메일 템플릿 API 이메일 발송 API 결론 1. 개요 글 작성에 앞서 알림(Notification) 도메인 중 이메일 알림 시스템을 담당하는 API 명세서와 아키텍처 구조를 정리했습니다. 주요 구성 요소는 (템플릿 관리)와 (발송 이력 관리) 두 개의 테이블로 구성되어 있습니다. 2. 시스템 아키텍처 3. ERD 구조 4. API 명세서 기본 정보 Base URL: https://api.paystream.com/v1 인증 방식: JWT 응답 형식: JSON 공통 규칙 사용 Method: 모든 인증이 필요한 요청은 헤더에 포함 날짜/시간은 ISO 8601 형식() ENUM 필드는 API 문서에서 허용 값과 기본값을 명시 공통 에러 응답 포맷 이메일 템플릿 API 1. 템플릿 목록 조회 설명: 등록된 이메일 템플릿 목록을 페이지네이션과 함께 조회합니다. 템…
2025.09.26