인터페이스 설계 (Interface Design)

내부/외부 시스템 간 인터페이스를 정의합니다.

목차

  1. 1. API 설계 원칙
  2. 2. API 엔드포인트
    1. 2.1 [도메인명] API (예: 인증 API)
  3. 3. 외부 시스템 연동
    1. 3.1 [외부 시스템명]
  4. ✅ 완료 체크리스트

1. API 설계 원칙

  • RESTful 원칙 준수
  • 일관된 네이밍 규칙
  • 버전 관리 전략
  • 에러 처리 표준

2. API 엔드포인트

2.1 [도메인명] API (예: 인증 API)

메서드 경로 설명 인증 필요
POST /api/v1/auth/login 로그인 ❌
POST /api/v1/auth/register 회원가입 ❌
GET /api/v1/users/me 내 정보 조회 ✅

예시 요청/응답:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

// POST /api/v1/auth/login
{
  "email": "user@example.com",
  "password": "password123"
}

// 200 OK
{
  "accessToken": "eyJhbGc...",
  "refreshToken": "eyJhbGc...",
  "user": {
    "id": "123",
    "email": "user@example.com"
  }
}

3. 외부 시스템 연동

3.1 [외부 시스템명] 

sequenceDiagram
    participant System as 우리 시스템
    participant External as 외부 시스템

    System->>External: API 호출
    External-->>System: 응답

연동 정보:

  • 프로토콜: REST API / SOAP / GraphQL
  • 인증: API Key / OAuth 2.0
  • Rate Limit: [제한 사항]

✅ 완료 체크리스트

  • API 설계 원칙 정의 완료
  • 주요 엔드포인트 정의 완료
  • 외부 시스템 연동 방식 정의 완료