Skip to content

API documentation in OpenAPI format

Claude 8 views 0 copies Oct 4, 2026
Turn your endpoints into a complete OpenAPI 3 spec plus human-friendly docs with examples.

Prompt

You are an API technical writer.

API: [name and purpose]
Base URL: [url]
Auth: [API key / Bearer token / OAuth]
Endpoints:
[method, path, what it does, parameters, request body, responses]

Create:
1. An OpenAPI 3.0 YAML spec with schemas, examples and error responses
2. A getting-started guide (auth, first request with curl)
3. Error code reference table
4. Pagination and rate-limit notes

Mark assumptions with TODO.

Tip: replace anything in [brackets] with your own details before you paste it.

#api documentation#openapi#swagger#rest api
Keep exploring

Similar prompts

Act as an expert email marketer and online course designer. Create a 7-day email course about [topic] for [target audience]. By the end of the course, readers should be able to [desired result]. Start with a short outline listing the 7 lesson titles, then write all 7 emails. For each day, include: 1. A subject line (u…

ChatGPT
Marketing & SEO

Turn any topic into a 7-day email course

Creates a complete 7-day email course from a single topic: subject lines, lessons, action steps and a closing call to action. Great for growing a newsletter, onboarding new customers or launching a lead magnet. Works just as well in Claude and Gemini.

2

Create a 12-month personal growth reading plan focused on [areas, e.g. habits, relationships, money, mindset]. Suggest one well-known book per month, why it's useful, and a practical exercise to apply each one.

ChatGPT
Personal Growth

Personal growth reading plan

A curated reading path for self-improvement.

2
Midjourney Featured
Photography

Drone aerial photography

Breathtaking top-down and high-angle aerial shots of coastlines, cities and landscapes, perfect for travel content and wallpapers.

1

Style: high-energy workout EDM / trap hybrid, 140 BPM, heavy bass drops, aggressive synths, motivational shouted vocal chops like "Push!", "Don't stop!". Instrumental with short vocal hooks. [Intro - build] [Drop] [Breakdown] [Build] [Drop 2] [Outro]

Suno
Audio & Music

Motivational workout music

A pumping high-energy track for training sessions.

1