Mit használtak a Swaggerben?

A Swagger egy eszközkészlet az REST API-k leírására, dokumentálására és tesztelésére.

A Swaggerrel általában a következőket használják:

• OpenAPI Specification (korábban Swagger Specification) — szabvány az API leírására YAML vagy JSON formátumban.
• Swagger Editor — webes eszköz az OpenAPI specifikációk írására és szerkesztésére.
• Swagger UI — automatikusan generált interaktív API dokumentáció, amely lehetővé teszi a kérések közvetlen tesztelését a böngészőből.
• Swagger Codegen — kliens SDK-k és szerver sablonok generálása a specifikáció alapján.

A Swagger használata lehetővé teszi:

• Az API szerkezetének világos leírását.
• Egyetlen igazságforrás biztosítását a fejlesztők számára.
• Az integráció és tesztelés egyszerűsítését.

Példa egy egyszerű GET kérés leírására OpenAPI-ban:

paths:
  /orders:
    get:
      summary: Rendelések listájának lekérése
      responses:
        '200':
          description: Sikeres válasz
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Order'