Milyen típusú szerződések alkalmazhatók REST API létrehozásakor?

REST API létrehozásakor a következő szerződéstípusokat alkalmazzák:

• OpenAPI (Swagger) — szabvány a REST API-k leírására, amely lehetővé teszi a dokumentációt és az ügyfélkód generálását.
• JSON Schema — meghatározza a kérésben és válaszban használt JSON objektumok szerkezetét.
• gRPC (bár ez nem REST, néha szerződésként használják API-khoz) — protobuf alapú szerződéssel rendelkező protokoll.

A REST API-k kontextusában leggyakrabban az OpenAPI-t használják, amely leírja:

• Végpontokat (útvonalak és HTTP-módszerek)
• Kérések és válaszok formátumait
• Paramétereket és fejlécet
• Válaszkódokat

Egyszerű OpenAPI-részlet példája:

paths:
  /users:
    get:
      summary: Felhasználók listájának lekérése
      responses:
        '200':
          description: Sikeres válasz
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'