@openapi-generatorSpec OpenAPI 3.1 depuis ton code, sans invention

Le problème qu'il résout

Ton API Node existe depuis 2 ans. Tu veux exposer Swagger UI à tes consumers, mais tu n'as pas envie d'annoter chaque route avec des décorateurs JSDoc. Tu veux une spec qui matche le code réellement déployé, pas un .yaml séparé qui dérive avec le temps.

@openapi-generator lit ton code et écrit openapi.yaml. Tu drop dans Swagger UI → doc interactive en 2 minutes.

Comment il bosse

1. Détecte le framework via les manifests.
2. Localise les routes / handlers.
3. Extrait pour chaque endpoint : path, method, params, body, response, auth.
4. Pour TypeScript, lit les interface et type et les convertit en schemas OpenAPI.
5. Émet une spec OpenAPI 3.1 valide avec $ref pour réutiliser les schemas.
6. Si un endpoint manque de types/docblocks, flag plutôt qu'inventer.

Exemple concret

Tu tapes

›@openapi-generator analyse src/routes/ (Express + TypeScript) et génère openapi.yaml.

Tu obtiens

openapi: 3.1.0
info:
  title: Tasky API
  version: 1.2.0
servers:
  - url: https://api.example.com/v1
security:
  - bearerAuth: []
paths:
  /users:
    get:
      summary: List users
      parameters:
        - in: query
          name: limit
          schema: { type: integer, default: 25, maximum: 100 }
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema: { $ref: '#/components/schemas/UserListResponse' }
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    User:
      type: object
      required: [id, email, created_at]
      properties:
        id: { type: integer, format: int64 }
        ...

Pourquoi tu vas l'aimer

Quand l'utiliser

Combine avec ces agents

Questions fréquentes