Junior — Middle

Aké typy zmlúv sa používajú pri vytváraní REST API?

sobes.tech AI

Odpoveď od AI

Pri tvorbe REST API uporabljamo naslednje vrste pogodb:

OpenAPI (Swagger) — standard za opis REST API-jev, ki omogoča dokumentacijo in generiranje odjemalske kode.
JSON Schema — določa strukturo JSON objektov, ki se uporabljajo v zahtevah in odgovorih.
gRPC (čeprav to ni REST, ga včasih uporabljajo kot pogodbo za API) — protokol s pogodbo, ki temelji na protobuf.

V kontekstu REST API-jev se najpogosteje uporablja OpenAPI, ki opisuje:

Končne točke (poti in HTTP metode)
Formate zahtevkov in odgovorov
Parametre in glave
Kode odgovorov

Primer preprostega fragmenta OpenAPI:

paths:
  /users:
    get:
      povzetek: Pridobi seznam uporabnikov
      responses:
        '200':
          opis: Uspešen odgovor
          vsebina:
            application/json:
              shema:
                type: array
                items:
                  $ref: '#/components/schemas/User'

Predchádzajúce Ďalej