Obsługa OpenAPI Specification 3.0 | Qlik Cloud Pomoc
Przeskocz do zawartości głównej Przejdź do treści uzupełniającej
Zasoby Qlik
Ładowanie wyszukiwania SearchUnify Jeżeli potrzebujesz pomocy z produktem, skontaktuj się z Pomocą techniczną Qlik.
Portal klientów Qlik
Ładowanie wyszukiwania SearchUnify Jeżeli potrzebujesz pomocy z produktem, skontaktuj się z Pomocą techniczną Qlik.
Portal klientów Qlik

Obsługa OpenAPI Specification 3.0

Zaprojektuj API za pomocą OpenAPI Specification (OAS) 3.0, używając API Designer.

OpenAPI Specification 3.0 wprowadza nowe cechy, zapewniając większą wyrazistość i produktywność projektantom API.

Aby uzyskać więcej informacji na temat OpenAPI, zobacz dokumentację Swagger.

Komponenty

Komponenty pozwalają na ponowne użycie różnych elementów w całym API. Te elementy to mogą być:
  • Zmienne ścieżki
  • Parametry zapytania
  • Nagłówki
  • Odpowiedzi

Kombinacje

Kombinacje pozwalają na utworzenie nowego typu danych poprzez połączenie kilku innych typów danych. API Designer obsługuje dwa typy kombinacji:
  • Kompozycja (allOf) pozwala na agregowanie właściwości schematu z różnych schematów. Na przykład, możesz zdefiniować typ danych Company, ponownie używając wszystkich właściwości z istniejących typów Contact i Error.
    Przykład kompozycji.
  • Polimorfizm (oneOf/anyOf) pozwala na utworzenie encji, która może używać właściwości z różnych typów danych.
    • oneOf pozwala na zdefiniowanie typu danych zawierającego właściwości jednego z wybranych typów. Na przykład, jeśli utworzysz operację pobierania informacji o koncie usługi, możesz zdefiniować odpowiedź za pomocą kombinacji oneOf, aby uzyskać wszystkie właściwości Error lub wszystkie właściwości ServiceAccountCount.
      Przykład polimorfizmu.
    • anyOf pozwala na zdefiniowanie typu danych zawierającego właściwości jednego lub kilku wybranych typów. Na przykład, możesz zdefiniować typ danych nervousSystem oraz typ skeleton zawierające różne właściwości, i użyć kombinacji anyOf, aby utworzyć typ danych zawierający dowolne właściwości z któregokolwiek z tych typów.

      Kombinacja anyOf jest prawidłowa, o ile zawiera wszystkie wymagane parametry co najmniej jednego z wybranych typów danych. Poniższy przykład używa właściwości brain_weight z typu nervousSystem oraz właściwości skull_height i teeth z typu skeleton.

      Przykład kombinacji używającej typów danych nervousSystem i skeleton.

Aby uzyskać więcej informacji na temat kompozycji i polimorfizmu, zobacz Dziedziczenie i polimorfizm oraz Różnica między anyOf i oneOf.

Odpowiedzi

OAS 3.0 pozwala na zdefiniowanie nowych typów odpowiedzi dla Twoich operacji:
  • Zakresy odpowiedzi: zamiast definiować odpowiedź taką jak 200, możesz ustawić ją jako 2XX, dzięki czemu obejmie ona odpowiedzi od 200 do 299.
  • Odpowiedzi domyślne: możesz zdefiniować domyślną odpowiedź, która zostanie zwrócona, gdy nie zdefiniowano konkretnej odpowiedzi lub zakresu odpowiedzi.
Odpowiedzi zdefiniowane za pomocą jawnego kodu mają pierwszeństwo przed zakresami odpowiedzi i odpowiedziami domyślnymi, a zakresy odpowiedzi mają pierwszeństwo przed odpowiedziami domyślnymi. W poniższym przykładzie:
  • Odpowiedź 204 jest zdefiniowana i ma pierwszeństwo przed pozostałami.
  • Odpowiedź 2XX ma zastosowanie do kodów odpowiedzi od 200 do 203 oraz od 205 do 299.
  • Odpowiedź default ma zastosowanie do wszystkich odpowiedzi 1XX, 3XX, 4XX i 5XX.
Sekcja odpowiedzi.

Zabezpieczenia

OAS 3.0 wprowadza nowe schematy zabezpieczeń dla Twojego API:
  • Uwierzytelnianie Bearer
  • OpenIdConnect

Ograniczenia

OAS 3.0 pozwala na wskazanie, że niektóre właściwości są tylko do odczytu lub tylko do zapisu.

Ta opcja jest dostępna tylko w typach danych i nie może być zdefiniowana w żądaniach ani odpowiedziach na poziomie operacji.

Przykład ograniczenia.

Czy ta strona była pomocna?

Jeżeli natkniesz się na problemy z tą stroną lub jej zawartością — literówkę, brakujący krok lub błąd techniczny — daj nam znać!

Przekaż tu opinię