OpenAPI Spec — Animate | AI Wisdom

← Back to topic
🎞 ANIMATE · Mode 3 of 5 · +100 XP— OpenAPI Specification
📋Info/Security
⚙️Schemas
🔄Paths
✅Code Gen
🎯 Next: Test →
Step 1 / 4
Speed
Info/Security
OpenAPI header — API metadata and security definitions💡 Analogy
Like the cover and terms page of a contract — who made it, what version, how to authenticate.
The info section documents version, title, and description. securitySchemes defines how to authenticate — bearerAuth with JWT in this case.
Console Output
> OpenAPI 3.1.0 parsed
> Security scheme: JWT Bearer
> Servers: [https://api.example.com/v2]
●openapi.yaml
Info/SecurityL1–12
1openapi: 3.1.0
2info:
3  title: Blog API
4  version: 2.0.0
5  description: RESTful blog API with OpenAPI 3.1
6 
7components:
8  securitySchemes:
9    bearerAuth:
10      type: http
11      scheme: bearer
12      bearerFormat: JWT
13 
14  schemas:
15    Post:
16      type: object
17      required: [id, title, body, authorId]
18      properties:
19        id:     { type: string, format: uuid }
20        title:  { type: string, minLength: 3, maxLength: 200 }
21        body:   { type: string }
22        authorId: { type: string, format: uuid }
23        tags:   { type: array, items: { type: string } }
24 
25    CreatePostDto:
26      type: object
27      required: [title, body]
28      properties:
29        title: { type: string, minLength: 3, maxLength: 200 }
30        body:  { type: string, minLength: 10 }
31 
32paths:
33  /posts:
34    get:
35      summary: List posts
36      security: [{ bearerAuth: [] }]
37      parameters:
38        - name: tag
39          in: query
40          schema: { type: string }
41      responses:
42        '200':
43          content:
44            application/json:
45              schema:
46                type: array
47                items: { $ref: '#/components/schemas/Post' }
48    post:
49      summary: Create post
50      requestBody:
51        required: true
52        content:
53          application/json:
54            schema: { $ref: '#/components/schemas/CreatePostDto' }
55      responses:
56        '201':
57          description: Created
58          headers:
59            Location: { schema: { type: string } }
59 lines
Timeline — 4 Steps
Info/Security
OpenAPI header — API metadata and security definitions💡 Analogy
Like the cover and terms page of a contract — who made it, what version, how to authenticate.
The info section documents version, title, and description. securitySchemes defines how to authenticate — bearerAuth with JWT in this case.
Console Output
> OpenAPI 3.1.0 parsed
> Security scheme: JWT Bearer
> Servers: [https://api.example.com/v2]

Was this page helpful?

Discussion

OpenAPI header — API metadata and security definitions

💡 Analogy

Like the cover and terms page of a contract — who made it, what version, how to authenticate.

The info section documents version, title, and description. securitySchemes defines how to authenticate — bearerAuth with JWT in this case.

Console Output

> OpenAPI 3.1.0 parsed
> Security scheme: JWT Bearer
> Servers: [https://api.example.com/v2]

OpenAPI header — API metadata and security definitions

💡 Analogy

Like the cover and terms page of a contract — who made it, what version, how to authenticate.

The info section documents version, title, and description. securitySchemes defines how to authenticate — bearerAuth with JWT in this case.

Console Output

> OpenAPI 3.1.0 parsed
> Security scheme: JWT Bearer
> Servers: [https://api.example.com/v2]