REST API yaradılarkən hansı növ müqavilələr tətbiq olunur?

REST API yaradarkən aşağıdakı müqavilə növləri tətbiq olunur:

• OpenAPI (Swagger) — REST API-ləri təsvir etmək üçün standartdır, sənədləşdirməyə və müştəri kodu yaratmağa imkan verir.
• JSON Schema — sorğularda və cavablarda istifadə olunan JSON obyektlərinin quruluşunu müəyyən edir.
• gRPC (baxmayaraq ki, bu REST deyil, bəzən API üçün müqavilə kimi istifadə olunur) — protobuf əsasında müqaviləli protokol.

REST API kontekstində ən çox OpenAPI istifadə olunur, o aşağıdakıları təsvir edir:

• Nöqtələr (yollar və HTTP metodları)
• Sorğu və cavab formatları
• Parametrlər və başlıqlar
• Cavab kodları

Sadə bir OpenAPI fraqment nümunəsi:

paths:
  /users:
    get:
      summary: İstifadəçilərin siyahısını əldə et
      responses:
        '200':
          description: Uğurlu cavab
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'