REST API oluşturulurken hangi sözleşme türleri uygulanır?

REST API oluşturulurken aşağıdaki sözleşme türleri kullanılır:

• OpenAPI (Swagger) — REST API'leri tanımlamak için standarttır, belgelemeye ve istemci kodu oluşturmaya olanak tanır.
• JSON Schema — isteklerde ve yanıtlerde kullanılan JSON nesnelerinin yapısını tanımlar.
• gRPC (ki bu REST değildir, ancak bazen API sözleşmesi olarak kullanılır) — protobuf tabanlı sözleşmeye sahip protokol.

REST API bağlamında genellikle OpenAPI kullanılır, bu da şunları tanımlar:

• Uç noktalar (yollar ve HTTP yöntemleri)
• İstek ve yanıt formatları
• Parametreler ve başlıklar
• Yanıt kodları

Basit bir OpenAPI parçası örneği:

paths:
  /users:
    get:
      summary: Kullanıcı listesi al
      responses:
        '200':
          description: Başarılı yanıt
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'