코딩 및 개발#API docs#documentation#endpoint#developer#chatgpt

API Documentation from Code Prompt

Generate endpoint docs with method, auth, request/response schemas, and examples.

호환 AI 도구:ChatGPTClaudeGeminiMicrosoft Copilot
전체 프롬프트
Generate API documentation in markdown for the following endpoint code.
```[language]
[paste handler / function]
```
Include:
- Endpoint URL and HTTP method
- Authentication requirements
- Request schema with field types and example
- Response schema with success and error examples
- Error codes and their meanings
- Rate limits or idempotency notes
- A short description of business logic
Format with H3 sections and code blocks.
💡
Marqly로 나만의 AI 프롬프트 라이브러리 정리하기

수많은 대화 기록 속에서 유용한 프롬프트를 다시 잃어버리지 마세요. Marqly 확장 프로그램을 통해 ChatGPT, Claude, Gemini에서 직접 스크랩하고 Pro 시맨틱 검색으로 쉽게 찾으세요.

원클릭 프롬프트 스크랩 · 라이브러리 전체 대상 Pro 시맨틱 검색 · AI 대화 내용을 안전하게 보관하고 작업 참고 자료와 함께 프롬프트를 보관하는 방법을 확인해보세요.

How to use this prompt

Paste the smallest relevant code block. Review, test, and lint any generated code before merging; models can hallucinate APIs.

  1. Copy the full prompt above.
  2. Replace the bracketed placeholders with your own details.
  3. Paste it into chatgpt, claude, gemini (or your preferred AI tool).
  4. Iterate on the output: add constraints, ask follow-ups, or combine multiple results.

Why this prompt works

It gives the AI a clear role, specific inputs, and an output format. That structure reduces vague responses and gives you a draft you can refine in minutes instead of hours.

자주 묻는 질문

What if the code doesn't show auth logic?

State the assumption and flag the missing auth detail for verification.

Can I generate docs for a whole API?

Yes, but process endpoints one at a time or in small groups for better accuracy.

Last updated:

홈 · Marqly