KoreaAI Hub
← 프롬프트 목록
개발ChatGPT

API 문서 자동 작성

API 엔드포인트 코드를 입력하면 OpenAPI/Swagger 스타일의 문서를 자동 생성합니다.

공유:X
프롬프트 전문
Generate professional API documentation for the following endpoint.

[Code or endpoint description]
```
{API 코드 또는 엔드포인트 설명}
```

Generate documentation in this format:

## Endpoint
- Method: GET/POST/PUT/DELETE
- URL:
- Description: (한국어)

## Request
### Headers
| Key | Value | Required |
|-----|-------|----------|

### Parameters / Body
| Field | Type | Required | Description |
|-------|------|----------|-------------|

## Response
### Success (200)
```json
{예시 JSON 응답}
```

### Error Responses
| Status | Code | Message |
|--------|------|---------|

## Example (curl)
```bash
{curl 예시}
```

사용 방법

  1. 1위 "프롬프트 복사" 버튼을 클릭하세요.
  2. 2ChatGPT 채팅창에 붙여넣기 하세요.
  3. 3중괄호 {변수} 부분을 실제 내용으로 교체하세요.
#API#문서#개발#OpenAPI