Kas tika izmantots Swagger'ā?

Swagger ir instrumentu komplekts REST API aprakstīšanai, dokumentēšanai un testēšanai.

Ko parasti izmanto ar Swagger:

• OpenAPI Specification (iepriekš Swagger Specification) — standarts API aprakstīšanai YAML vai JSON formātā.
• Swagger Editor — tīmekļa rīks OpenAPI specifikāciju rakstīšanai un rediģēšanai.
• Swagger UI — automātiski ģenerēta interaktīva API dokumentācija, kas ļauj tieši pārlūkprogrammā testēt pieprasījumus.
• Swagger Codegen — klientu SDK un servera šablonu ģenerēšana pēc specifikācijas.

Swagger lietošana ļauj:

• Skaidri aprakstīt API struktūru.
• Nodrošināt vienu patiesības avotu izstrādātājiem.
• Vienkāršot integrāciju un testēšanu.

Piemērs vienkāršam GET pieprasījumam OpenAPI:

paths:
  /orders:
    get:
      summary: Saņemt pasūtījumu sarakstu
      responses:
        '200':
          description: Veiksmīga atbilde
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Order'