Jaké typy smluv se používají při vytváření REST API?

Při vytváření REST API se používají následující typy kontraktů:

• OpenAPI (Swagger) — standard pro popis REST API, který umožňuje dokumentaci a generování klientského kódu.
• JSON Schema — definuje strukturu JSON objektů používaných v požadavcích a odpovědích.
• gRPC (ačkoliv to není REST, někdy se používá jako kontrakt pro API) — protokol s kontraktem založeným na protobuf.

V kontextu REST API se nejčastěji používá OpenAPI, který popisuje:

• Endpointy (cesty a metody HTTP)
• Formáty požadavků a odpovědí
• Parametry a hlavičky
• Kódy odpovědí

Příklad jednoduchého fragmentu OpenAPI:

paths:
  /users:
    get:
      summary: Získat seznam uživatelů
      responses:
        '200':
          description: Úspěšná odpověď
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'