API Specification in OpenAPI Format

D

Daniel Okoye

@daniel-okoye

·

Generate API documentation in OpenAPI/Swagger format.

47 copies0 forks
Share this prompt:
Generate OpenAPI 3.0 specification for this API:

API Description:
{{api_description}}

Endpoints:
{{endpoints}}

Data Models:
{{data_models}}

Output complete OpenAPI specification:

```yaml
openapi: 3.0.3
info:
  title: {{api_title}}
  version: 1.0.0
  description: |
    [Detailed description]

servers:
  - url: https://api.example.com/v1
    description: Production

paths:
  /resource:
    get:
      summary: Get resource
      operationId: getResource
      tags: []
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resource'

components:
  schemas:
    Resource:
      type: object
      properties:
        id:
          type: string
      required:
        - id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

security:
  - bearerAuth: []
```

Ensure:
- All endpoints fully documented
- Request/response schemas complete
- Error responses included
- Authentication documented
- Valid OpenAPI 3.0 syntax

Details

Category

Coding

Use Cases

API documentation generationContract-first API designSwagger spec creation

Works Best With

claude-opus-4.5gpt-5.2gemini-2.0-flash
Created Updated Shared

Related Prompts

Create your own prompt vault and start sharing