OpenAPI Specification 3.0 desteği | Qlik Cloud Yardımı
Ana içeriğe geç Tamamlayıcı içeriğe geç
Qlik Kaynakları
SearchUnify araması yükleniyor Ürününüzle ilgili yardıma ihtiyacınız varsa lütfen Qlik Desteği ile iletişime geçin.
Qlik Müşteri Portalı
SearchUnify araması yükleniyor Ürününüzle ilgili yardıma ihtiyacınız varsa lütfen Qlik Desteği ile iletişime geçin.
Qlik Müşteri Portalı

OpenAPI Specification 3.0 desteği

API Designer kullanarak OpenAPI Specification (OAS) 3.0 ile bir API tasarlayın.

OpenAPI Specification 3.0, API tasarımcılarına daha fazla ifade gücü ve üretkenlik getiren yeni özelliklerle birlikte gelir.

OpenAPI hakkında daha fazla bilgi için bkz. Swagger belgeleri.

Bileşenler

Bileşenler, bir API genelinde çeşitli öğeleri yeniden kullanmanıza olanak tanır. Bu öğeler şunlar olabilir:
  • Yol değişkenleri
  • Sorgu parametreleri
  • Üst bilgiler
  • Yanıtlar

Kombinasyonlar

Kombinasyonlar, birkaç farklı veri türünü birleştirerek yeni bir veri türü oluşturmanıza olanak tanır. API Designer iki tür kombinasyonu destekler:
  • Bileşim (allOf), farklı şemalardaki şema özelliklerini bir araya getirmenize olanak tanır. Örneğin, mevcut Contact ve Error türlerindeki tüm özellikleri yeniden kullanarak bir Company veri türü tanımlayabilirsiniz.
    Bir bileşim örneği.
  • Polimorfizm (oneOf/anyOf), farklı veri türlerindeki özellikleri kullanabilen bir varlık oluşturmanıza olanak tanır.
    • oneOf, seçilen türlerden birinin özelliklerini içeren bir veri türü tanımlamanıza olanak tanır. Örneğin, bir hizmet hesabı hakkında bilgi almak için bir işlem oluşturursanız, Error öğesinin tüm özelliklerini veya ServiceAccountCount öğesinin tüm özelliklerini almak için oneOf kombinasyonunu kullanarak yanıtı tanımlayabilirsiniz.
      Bir polimorfizm örneği.
    • anyOf, seçilen türlerden birinin veya birkaçının özelliklerini içeren bir veri türü tanımlamanıza olanak tanır. Örneğin, farklı özellikler içeren bir nervousSystem veri türü ve bir skeleton türü tanımlayabilir ve bu türlerin herhangi birinden herhangi bir özelliği içeren bir veri türü oluşturmak için anyOf kombinasyonunu kullanabilirsiniz.

      Bir anyOf kombinasyonu, seçilen veri türlerinden en az birinin tüm gerekli parametrelerini içerdiği sürece geçerlidir. Aşağıdaki örnek, nervousSystem türünden brain_weight özelliğini ve skeleton türünden skull_height ile teeth özelliklerini kullanır.

      nervousSystem ve skeleton veri türlerini kullanan bir kombinasyon örneği.

Bileşim ve polimorfizm hakkında daha fazla bilgi için bkz. Kalıtım ve Polimorfizm ve anyOf ve oneOf Arasındaki Fark.

Yanıtlar

OAS 3.0, işlemleriniz için yeni yanıt türleri tanımlamanıza olanak tanır:
  • Yanıt aralıkları: 200 gibi bir yanıt tanımlamak yerine, 200 ile 299 arasındaki yanıtları içerecek şekilde 2XX olarak ayarlayabilirsiniz.
  • Varsayılan yanıtlar: Belirli bir yanıt veya aralık yanıtı tanımlanmadığında döndürülecek varsayılan bir yanıt tanımlayabilirsiniz.
Açık bir kodla tanımlanan yanıtlar, yanıt aralıklarına ve varsayılan yanıtlara göre önceliklidir ve yanıt aralıkları varsayılan yanıtlara göre önceliklidir. Aşağıdaki örnekte:
  • 204 yanıtı tanımlanmıştır ve diğerlerine göre önceliklidir.
  • 2XX yanıtı, 200 ila 203 ve 205 ila 299 arasındaki yanıt kodları için geçerlidir.
  • default yanıtı tüm 1XX, 3XX, 4XX ve 5XX yanıtları için geçerlidir.
Yanıtlar bölümü.

Güvenlik

OAS 3.0, API'niz için yeni güvenlik şemaları getirir:
  • Bearer kimlik doğrulaması
  • OpenIdConnect

Kısıtlamalar

OAS 3.0, bazı özelliklerin salt okunur veya salt yazılır olduğunu belirtmenize olanak tanır.

Bu seçenek yalnızca veri türlerinde mevcuttur ve işlem düzeyindeki isteklerde veya yanıtlarda tanımlanamaz.

Kısıtlama örneği.

Bu sayfa size yardımcı oldu mu?

Bu sayfa veya içeriği ile ilgili bir sorun; bir yazım hatası, eksik bir adım veya teknik bir hata bulursanız lütfen bize bildirin!

Geri bildiriminizi buradan iletin