Na čo sa používa Swagger?

Swagger (teraz OpenAPI Specification) sa používa na opis, dokumentáciu a vizualizáciu RESTful API. To umožňuje vývojárom, testerom a spotrebiteľom API pochopiť funkčnosť služby bez prístupu ku zdrojovému kódu.

Hlavné funkcie:

1. Dokumentácia: Automatické vytváranie interaktívnej dokumentácie API.
2. Vývoj: Pomáha pri vývoji API, poskytujúc jasnú definíciu zmluvy.
3. Testovanie: Rozhranie Swagger (Swagger UI) umožňuje testovať koncové body API priamo z prehliadača.
4. Generovanie kódu: Môže generovať klientsky kód (SDK) alebo serverové stuby na základe špecifikácie OpenAPI.
5. Dizajn: Môže byť použitý ako nástroj na navrhovanie API pred začatím kódovania (Design-First prístup).

Príklad fragmentu špecifikácie vo formáte YAML:

# Krátky popis API
openapi: 3.0.0
info:
  title: Môj testovací API
  version: 1.0.0
paths:
  /items:
    get:
      summary: Získať zoznam všetkých prvkov
      responses:
        '200':
          description: Zoznam prvkov úspešne získaný
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Item'
components:
  schemas:
    Item:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string

Toto zabezpečuje konzistentnosť medzi rôznymi stranami zapojenými do vývoja a používania API.