OpenAPI ve istemci üretimi

Güncel makine tarafından okunabilir sözleşme:

https://api.sourcebilisim.com/v1/openapi.json

OpenAPI JSON dosyasını açın

Belge OpenAPI 3.1.0 biçimindedir ve şunları içerir:

• Üretim temel adresi ve Bearer güvenlik şeması
• Uç noktalar, yöntemler ve gerekli kapsamlar
• Yol ve sorgu parametreleri
• İstek/yanıt şemaları
• Standart hata yanıtları
• Sayfalama ve istek sınırı bilgileri
• Kararlı operationId değerleri

Postman veya Insomnia

Yeni bir koleksiyon oluştururken yukarıdaki URL'yi OpenAPI import kaynağı olarak kullanın. Ortam değişkeni olarak baseUrl=https://api.sourcebilisim.com/v1 ve gizli apiKey değeri tanımlayın. Anahtarı dışa aktarılan koleksiyon dosyasına gömmeyin.

Kod üretimi

npx @openapitools/openapi-generator-cli generate \
  -i https://api.sourcebilisim.com/v1/openapi.json \
  -g typescript-fetch \
  -o ./generated/source-api

Üretilen kodu uygulamanızın sunucu tarafında kullanın. Sözleşmedeki x-required-scope, her işlemin istediği anahtar kapsamını; x-rate-limits ise platform sınırlarını açıklar.