API documentation generator prompt

Paste an endpoint's code and get full documentation: parameters, request and response examples, and error codes.

بواسطة ‪Ahmed Eid‬‏Claude0 نسخة

متى تستخدم هذا البرومبت

  • Before publishing a public or internal API reference.
  • When a new endpoint ships without docs.
  • When preparing an OpenAPI/Swagger description manually.

نص البرومبت

Write clear API documentation for this {{language}} endpoint, including method, path, parameters, request/response examples, and possible error codes. Style: {{framework}}.

{{CLIPBOARD}}
{{language}}{{framework}}{{CLIPBOARD}}

الكتلة {{CLIPBOARD}} تُستبدل تلقائياً بما نسخته قبل الضغط على «نسخ».

كيف تستخدمه

  1. انسخ البرومبت بالزر أو املأ المتغيرات أولاً.
  2. الصقه في ChatGPT أو Claude أو Gemini.
  3. عدّل النتيجة أو أعد الطلب بتغيير المتغيرات.

مثال على النتيجة

### POST /api/users

Creates a new user account.

Body parameters:
- email (string, required)
- password (string, required)

Response 201:
{ \"id\": \"u_123\", \"email\": \"a@b.com\" }

Errors:
- 409: email already registered

نصائح للاستخدام

  • Paste the route handler plus any validation schema for the most accurate parameter list.
  • Ask for OpenAPI/Swagger YAML output if you need it machine-readable.
  • Include one real request/response example if you have one, for tone matching.

النماذج الموصى بها

Claude

أسئلة شائعة

Can it generate an OpenAPI spec instead of markdown?
Yes, ask for OpenAPI 3.0 YAML output explicitly and it will structure the same information that way.
What if my endpoint has no comments at all?
It documents based on the code's actual logic and validation; unclear behavior will be flagged rather than guessed.

برومبتات ذات صلة

Generate a GraphQL Schema from a Description

Describe your data and operations in plain English and get a complete, documented GraphQL schema.

Design a GraphQL schema (types, queries, mutations) for: {{focus}}. Use {{language}} conventions and include field-level descriptions. {{CLIPBOARD}}

{{focus}}{{language}}{{CLIPBOARD}}

Generate Realistic Mock Data for Testing

Get realistic, varied mock data, including edge cases, matched to your schema, ready to seed a test database.

Generate {{focus}} realistic mock/test data records in {{language}} format for this schema or type, with varied and edge-case values. {{CLIPBOARD}}

{{focus}}{{language}}{{CLIPBOARD}}

Explain What This Legacy Code Actually Does

Paste unfamiliar or legacy code and get a plain-language walkthrough, with dead code and possible bugs flagged.

Walk through this {{language}} code line by line and explain what it does, in plain language. Flag anything that looks like dead code, a workaround, or a potential bug. {{CLIPBOARD}}

{{language}}{{CLIPBOARD}}

Generate a Dockerfile for Your App

Get a secure, optimized Dockerfile tailored to your language and framework, ready to build and run.

Write a production-ready Dockerfile for a {{language}} app using {{framework}}. Use multi-stage builds where useful, minimize image size, and run as a non-root user. Notes: {{focus}}. {{CLIPBOARD}}

{{language}}{{framework}}{{focus}}{{CLIPBOARD}}
المزيد في برمجة ←