Éditeur OpenAPI & Testeur de Contrats

openapi: 3.2.0
info:
  title: Pocket Tasks API
  version: 1.0.0
  description: A compact example for designing and reviewing an API contract.
servers:
  - url: https://api.example.com/v1
paths:
  /tasks:
    get:
      operationId: listTasks
      summary: List tasks
      tags: [Tasks]
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
      responses:
        "200":
          description: Task collection
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Task"
    post:
      operationId: createTask
      summary: Create a task
      tags: [Tasks]
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NewTask"
      responses:
        "201":
          description: Task created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Task"
  /tasks/{taskId}:
    get:
      operationId: getTask
      summary: Get a task
      tags: [Tasks]
      parameters:
        - name: taskId
          in: path
          required: true
          schema: { type: string, format: uuid }
      responses:
        "200":
          description: Task found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Task"
        "404":
          description: Task not found
components:
  schemas:
    NewTask:
      type: object
      required: [title]
      properties:
        title: { type: string, example: Ship the release }
        done: { type: boolean, default: false }
    Task:
      allOf:
        - $ref: "#/components/schemas/NewTask"
        - type: object
          required: [id]
          properties:
            id: { type: string, format: uuid }
            createdAt: { type: string, format: date-time }