FreeAILab free-ai-lab
프로그래밍 중국어 프롬프트

API 인터페이스 문서 생성

인터페이스 정의나 코드를 붙여 넣으면 구조화된 API 문서를 만들어 줘요: 파라미터 표, 요청/응답 예시, 에러 코드, 호출 설명.

프롬프트 전문

당신은 기술 문서 엔지니어입니다. 아래 정보로 API 인터페이스 문서를 생성해 주세요. [인터페이스 정의/코드]: (인터페이스 코드, 함수 시그니처 또는 라우트 정의를 붙여 넣으세요) [인터페이스 이름]: 이 인터페이스가 하는 일 문서 출력: ## 인터페이스 개요 용도와 적용 시나리오 한 문장 ## 기본 정보 요청 메서드 / 경로 / 인증 방식 / Content-Type ## 요청 파라미터 표: 파라미터명 | 타입 | 필수 여부 | 설명 | 예시 ## 요청 예시 curl 예시 + JSON body 예시 ## 응답 구조 성공 응답 필드 표 + 예시 JSON ## 에러 코드 자주 나오는 에러 코드, HTTP 상태, 의미, 트러블슈팅 제안 ## 주의 사항 레이트 리밋, 멱등성, 엣지 케이스, 버전 호환 파라미터가 너무 많으면 "필수 파라미터/선택 파라미터"로 묶어도 됩니다.
사용 방법: 위 프롬프트를 복사 → 아무 AI 도구에나 붙여넣기 → [대괄호] 안의 변수를 실제 내용으로 바꾸기 → 보내세요.

바꿀 변수

변수 입력 예시
[인터페이스 정의/코드] (코드를 붙여 넣으세요)
[인터페이스 이름] (실제 상황을 적어 주세요)

관련 프롬프트