Skill LibraryPrompt Skill1 DesignsTop Views

API Reference Endpoint Contract

Design, audit, or implement OpenAPI/Swagger API reference pages, endpoint pages, parameter tables, request/response schemas, status matrices, try-it consoles, and SDK/cURL examples.

Skill Uses0

Recorded selections across prompt workflows.

Public Designs1

Ranked by views, then community favorites.

Prompt Lines10

Reusable instruction lines for generation.

Author@Interface Lab

Implementation

Skill Directive

Description

Design, audit, or implement OpenAPI/Swagger API reference pages, endpoint pages, parameter tables, request/response schemas, status matrices, try-it consoles, and SDK/cURL examples.

TagsImplementation

Skill Prompt

- Use for API reference, endpoint docs, OpenAPI/Swagger, Redoc, Scalar, try it, request/response schemas, auth scopes, and webhook/event docs; inputs must include method/path, source spec, auth, parameters, request body, responses/errors, examples, and target renderer.
- Define the endpoint task first: discover capability, make a first call, configure auth, debug an error, migrate versions, or compare endpoints; this determines schema density, examples, warnings, and try-it behavior.
- Endpoint identity must be visible in the first viewport: method, path, summary, operationId/tag, version, stability, deprecation/migration notes, and source spec; method color only supports text.
- Model auth and safety first: show auth type, header shape, scopes, tenant/project, and sandbox/production; use YOUR_API_KEY placeholders, never real tokens; write-method try-it is disabled by default or confirmed.
- Group parameters by path, query, header, and cookie, with required items first; include type, default, enum/format, constraints, description, example, and encoding notes.
- Pair request body schema with example; required nested fields, content type, nullable behavior, file upload, validation, and idempotency keys need explicit treatment.
- Responses need a status-code matrix: 2xx, validation/auth/permission, not found/conflict, rate limit, async accepted, and 5xx; each row includes meaning, schema/example, recovery, and retry safety.
- Try-it/playground needs environment selection, request preview, send/loading/success/error states, copyable cURL, request ID, CORS/proxy notes, and reset; destructive methods need explicit friction.
- Use code-example-copy-contract for code samples: cURL/SDK tabs, copy feedback, placeholders, syntax highlighting, clipboard fallback, and mobile local scrolling.
- Choose renderer by task: Swagger UI for standards-based interactive OpenAPI exploration, Redoc for readable three-panel static reference, Scalar for modern self-hosted reference/API client; custom docs must meet the same contract.

Public directive summary shown; Pro unlocks the full prompt.

Layout Info

Designs below are ordered by views. Top items use live previews; the rest stay fast thumbnail cards.

Unlock Pro All Skills

API Reference Endpoint Contract

More pages using API Reference Endpoint Contract