레시피 광장
?
사용자

AI 기반 API 설계 문서 초안 작성 가이드: 구조화된 프롬프트 레시피

새로운 API를 설계할 때, 초기 문서 초안 작성을 효율적으로 돕는 AI 프롬프트입니다. API의 목적, 주요 기능, 데이터 모델 등을 명확히 정의하는 데 활용하세요.

#api 설계#문서 초안#프롬프트 엔지니어링#restful api#개발 가이드
recipe.sh
당신은 경험 많은 API 설계자입니다. 아래 정보를 바탕으로 RESTful API 설계 문서의 초안을 작성해주세요.

## API 개요
*   **API 이름:** {{API 이름}}
*   **목표:** {{API가 해결하고자 하는 문제 또는 제공하는 기능}} 
*   **버전:** {{API 버전 (예: v1)}} 
*   **주요 사용 대상:** {{API를 주로 사용할 개발자 또는 시스템}}

## 기본 정보
*   **베이스 URL:** {{베이스 URL (예: https://api.example.com/v1)}}
*   **인증 방식:** {{인증 방식 (예: API Key, OAuth 2.0, JWT)}}
*   **데이터 포맷:** {{요청/응답 데이터 포맷 (예: JSON, XML)}}

## 엔드포인트 정의
각 엔드포인트에 대해 다음 정보를 상세히 작성해주세요:

### 엔드포인트 1: {{엔드포인트 경로 (예: /users)}}
*   **HTTP 메서드:** {{HTTP 메서드 (GET, POST, PUT, DELETE 등)}}
*   **설명:** {{이 엔드포인트의 기능에 대한 간략한 설명}}
*   **요청 파라미터:**
    *   **Path Parameters:** {{Path Parameters 목록 및 설명 (예: /users/{userId})}}
    *   **Query Parameters:** {{Query Parameters 목록, 타입, 필수 여부, 기본값, 설명 (예: limit: integer, optional, default=10, 페이지당 항목 수)}}
    *   **Request Body:** {{Request Body의 구조 (JSON 스키마 등) 및 필드 설명 (필수/선택, 타입, 제약조건 등)}}
        ```json
        // 예시 Request Body
        {
          "name": "{{예시 필드값}}",
          "email": "{{예시 필드값}}"
        }
        ```
*   **응답:**
    *   **성공 응답 (Status Code: {{성공 시 HTTP 상태 코드 (예: 200 OK, 201 Created)}}):**
        *   **Response Body:** {{Response Body의 구조 (JSON 스키마 등) 및 필드 설명}}
            ```json
            // 예시 Success Response Body
            {
              "id": "{{예시 필드값}}",
              "name": "{{예시 필드값}}"
            }
            ```
    *   **오류 응답 (Status Code: {{오류 시 HTTP 상태 코드 (예: 400 Bad Request, 401 Unauthorized, 404 Not Found, 500 Internal Server Error)}}):**
        *   **Response Body:** {{오류 응답의 구조 및 필드 설명 (예: errorCode, message)}}
            ```json
            // 예시 Error Response Body
            {
              "errorCode": "{{예시 필드값}}",
              "message": "{{예시 필드값}}"
            }
            ```

### 엔드포인트 2: {{엔드포인트 경로}}
*   ...(이하 엔드포인트 1과 동일한 형식으로 작성)... 

## 데이터 모델 (선택 사항)
API 전반에서 사용되는 주요 데이터 객체에 대한 정의입니다.

*   **{{데이터 모델 이름 (예: User)}}:**
    *   **필드:** {{필드명: 타입, 필수 여부, 설명 (예: id: string, required, 사용자 고유 식별자)}}
    *   **예시:**
        ```json
        {
          "id": "{{예시 필드값}}",
          "name": "{{예시 필드값}}",
          "email": "{{예시 필드값}}"
        }
        ```

## 추가 고려사항 (선택 사항)
*   **Rate Limiting:** {{Rate Limiting 정책}}
*   **버저닝 전략:** {{버저닝 전략}}
*   **보안:** {{추가적인 보안 고려사항}}

위 정보를 바탕으로 명확하고 구조화된 API 설계 문서 초안을 작성해주세요.
9
스크랩
20
좋아요
0
댓글
AI 기반 API 설계 문서 초안 작성 가이드: 구조화된 프롬프트 레시피