HomeFrameworksAPI Design & Documentation
AgencyNewv2.0L4 Semantic FrameworkUpdated July 2026

API Design & Documentation

Design, build, and document production-ready REST and GraphQL APIs with OpenAPI specs and developer portals

4.9(167 reviews)2.4K installs46 prompts6 stagesDev Tools
GPT-4ClaudeGoDaddy Airo

API Design & Documentation is the definitive AI framework for backend engineers and platform teams who need to design, implement, and document APIs that developers love. It covers the full API lifecycle: REST design principles, OpenAPI specification, GraphQL schema design, authentication patterns, error standards, developer documentation, and versioning. Every prompt produces production-ready specifications and documentation that follows industry best practices.

Full Access Unlocked

All 46 prompts · All 6 modules

30-day money-back guarantee
Secure checkout via Stripe
Lifetime updates (currently v2.0)
Instant delivery after purchase

"The OpenAPI spec generator produces complete, valid YAML that passes our linting rules. It cut our A..."

Staff Engineer · Developer Platform Team

Need expert implementation?

Hire an Orchestrator

Connect with a certified Prompt.Doctor Orchestrator to deploy this framework for you.

How to use this framework

No coding required. You will use ChatGPT or Claude as your AI tool. Follow these steps in order — do not skip ahead.

1

Purchase & download the framework

Click the buy button on this page. After checkout, go to the and hit Download .zip. Unzip it — you'll get a .md file (the full framework) and a .pdf (easy to read reference). Keep both open.

2

Open your project — new or existing

This dashboard is designed to integrate into any existing project or be built as a standalone app. If you already have a site in Airo (or Cursor, Bolt, etc.), open that project. If you're starting fresh, create a new project. The Orchestrator Prompt handles both cases — it scans what's already there and adds only what's missing.

3

Paste the Orchestrator Prompt into your builder's chat

Open the on this page. Copy the Orchestrator Prompt and paste it into your AI builder's chat. It will scaffold the full admin system — secure login, email marketing module, booking engine, and CMS — on top of your existing codebase. This takes 2–5 minutes.

4

Add your API keys as secrets

Critical — Novice Users

In your builder, go to Settings → Secrets and add the keys your app needs. For this framework: STRIPE_SECRET_KEY (for booking payments — get it from your Stripe dashboard), ANTHROPIC_API_KEY (for AI-assisted content — get it from console.anthropic.com), and DATABASE_URL (your MySQL connection string). No key is needed for the admin login, CMS, or email modules — those run on your existing infrastructure.

Don't have a MySQL server?

You can purchase a shared hosting plan with cPanel and MySQL at host.esgwon.dev. Once your account is set up, follow the step-by-step guide to create your database and connect it to your AI website builder.

How to set up cPanel MySQL & connect to your AI website →

Need help with Stripe?

Get your STRIPE_SECRET_KEY and STRIPE_PUBLISHABLE_KEY from your Stripe dashboard. The guide covers test keys, webhook setup, and going live.

Stripe API keys — setup & testing guide →

Need help with Anthropic?

Get your ANTHROPIC_API_KEY from console.anthropic.com. The guide covers model selection, cost management, and troubleshooting.

Anthropic API key — setup & model guide →

Prompting Airo after setup — always name the file

When asking Airo to add tables, columns, or features to the admin dashboard, always include src/server/lib/admin-db.ts in your prompt. Without it, Airo may target the wrong database. Example: "Add a bookings table in the admin database (src/server/lib/admin-db.ts) — do not touch any other database connection in this project."

See safe prompting examples →
5

Run the framework prompts inside your live app

Your app is now running in the builder's preview panel. Open the on this page, copy each prompt one at a time, and paste it into your builder's chat. Replace every [BRACKET] with your real data before sending. Work through the stages in order — each stage output feeds the next.

6

Test end-to-end, then publish or hand off to your client

Walk through the admin as a real user: log in, create a booking, send a test email campaign, update a CMS image, and run the Safe-to-Publish gate. Once everything passes, click Publish in your builder. Because this is a white-label dashboard, your client accesses it at /admin on their own domain — no Prompt.Doctor branding, no third-party login required.

Who is this for?

Backend engineers designing new APIs
Platform teams building internal or public APIs
Technical writers creating API documentation
Startups building developer-facing products

Everything you get

46 production-ready prompts across 6 API development areas
REST design: resource naming, HTTP method conventions, pagination, filtering, and sorting
OpenAPI spec: complete OpenAPI 3.1 YAML for endpoints, schemas, and security
GraphQL: schema design, query/mutation/subscription patterns, and resolver architecture
Auth patterns: JWT implementation, OAuth 2.0 flows, API key management, and RBAC
Error standards: consistent error response format, status code guide, and error catalog
Documentation: endpoint reference, getting started guide, code examples, and changelog

What's Inside

6 modules · 46 prompts · 6 workflow stages

Modules(6 total)

REST API Design System

RESTful resource naming conventions, HTTP method semantics, URL structure patterns, pagination (cursor and offset), filtering and sorting query parameters, and HATEOAS links.

8 prompts

OpenAPI Specification System

Complete OpenAPI 3.1 YAML generation for REST endpoints: paths, operations, request/response schemas, security schemes, and reusable components. Includes Zod schema to OpenAPI conversion.

10 prompts

GraphQL Schema System

GraphQL schema design: type definitions, query/mutation/subscription patterns, input types, enums, interfaces, unions, and N+1 problem solutions with DataLoader.

8 prompts

Authentication & Security System

JWT authentication (access + refresh token pattern), OAuth 2.0 authorization code flow, API key management, RBAC (role-based access control), and rate limiting implementation.

10 prompts

Error & Standards System

Consistent error response format (RFC 7807 Problem Details), HTTP status code decision tree, error catalog document, validation error format, and API contract testing patterns.

6 prompts

Documentation System

API getting started guide, endpoint reference template, code examples (curl, JavaScript, Python), SDK README template, API changelog format, and deprecation notice templates.

4 prompts
Sample Prompts(46 total)
OpenAPI 3.1 Specification·GPT-4

Generate a complete OpenAPI 3.1 specification in YAML for a [API NAME] REST API. Endpoints to document: [LIST ENDPOINTS, e.g., GET /users, POST /users, GET /users/{id}, PUT /users/{id}, DELETE /users/{id}]. For each endpoint include: summary, description, operationId, tags, parameters (path, query, header), request body schema, response schemas (200, 201, 400, 401, 403, 404, 422, 500), and security requirements. Include: info section (title, version, description), servers array, reusable components (schemas, responses, parameters, securitySchemes), and JWT bearer auth security scheme. Full valid YAML.

GraphQL Schema Design·GPT-4

Design a GraphQL schema for a [DOMAIN: e-commerce/social platform/SaaS/marketplace] application. Include: 1) Core types with all fields and descriptions, 2) Query type: list queries (with pagination using cursor-based connection pattern), single item queries, and search, 3) Mutation type: create, update, delete mutations with input types and payload types, 4) Subscription type: real-time events for key state changes, 5) Enums for status fields, 6) Interfaces for shared fields, 7) Error handling: union return types with error variants, 8) Directives: @deprecated with reason. Full SDL (Schema Definition Language) format with descriptions on all types and fields.

API Error Response Standard·GPT-4

Design a consistent error response standard for a REST API following RFC 7807 (Problem Details). Include: 1) Base error response schema (type, title, status, detail, instance, traceId), 2) Validation error extension (errors array with field, code, message), 3) HTTP status code decision tree (when to use 400 vs 422 vs 409 vs 404 etc.), 4) Error catalog: 20 common API errors with code, HTTP status, title, and description, 5) TypeScript interface for the error response, 6) Express middleware to produce consistent errors, 7) Client-side error handling pattern. Include examples for each error type.

Workflow Architecture(6 stages)

system

18 prompts

Stage 1

templates

14 prompts

Stage 2

architecture

8 prompts

Stage 3

workflow

6 prompts

Stage 4

Everything included

REST API design framework (RESTful conventions)
OpenAPI 3.1 specification generator
GraphQL schema design system
API authentication patterns (JWT, OAuth, API keys)
Error response & status code standards
Developer documentation system
API versioning & changelog framework
Full Access Unlocked

What builders say

"The OpenAPI spec generator produces complete, valid YAML that passes our linting rules. It cut our API documentation time from days to hours."

SE

Staff Engineer

Developer Platform Team

"The error response standard prompt gave us a consistent error format across 40+ endpoints in one session. Our frontend team said it was the best API they'd ever integrated with."

BL

Backend Lead

B2B SaaS Company

You have full access

All 46 prompts across 6 modules are unlocked for your account.

$139$209

Lifetime access