コーディング・開発#API docs#documentation#endpoint#developer#chatgpt

API Documentation from Code Prompt

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

対応ツール: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.
💡
AIプロンプトライブラリをMarqlyで整理

チャット履歴の中に役立つプロンプトが埋もれてしまうのを防ぎます。Marqly拡張機能を使ってChatGPT、Claude、Geminiから直接保存し、Proプランのセマンティック検索ですぐに見つけられます。

1クリックでプロンプトをクリップ · ライブラリ全体を横断する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