Stöd för OpenAPI Specification 3.0 | Qlik CloudHjälp
Gå till huvudinnehåll Gå till ytterligare innehåll
Qlik-resurser
Laddar sökning med SearchUnify Om du behöver hjälp med din produkt, kontakta Qlik Support.
Qlik kundportal
Laddar sökning med SearchUnify Om du behöver hjälp med din produkt, kontakta Qlik Support.
Qlik kundportal

Stöd för OpenAPI Specification 3.0

Designa ett API med OpenAPI Specification (OAS) 3.0 med hjälp av API Designer.

OpenAPI Specification 3.0 kommer med nya funktioner, vilket ger mer uttrycksfullhet och produktivitet för API-designers.

För mer information om OpenAPI, se Swagger-dokumentationen.

Komponenter

Komponenter gör att du kan återanvända olika element i ett API. Dessa element kan vara:
  • Sökvägsvariabler
  • Frågeparametrar
  • Headers
  • Svar

Kombinationer

Kombinationer gör att du kan skapa en ny datatyp genom att kombinera flera andra datatyper. API Designer stöder två typer av kombinationer:
  • Sammansättning (allOf) gör att du kan aggregera schemaegenskaper från olika scheman. Du kan till exempel definiera en datatyp Company genom att återanvända alla egenskaper från de befintliga typerna Contact och Error.
    Exempel på en sammansättning.
  • Polymorfism (oneOf/anyOf) gör att du kan skapa en entitet som kan använda egenskaperna från olika datatyper.
    • oneOf gör att du kan definiera en datatyp som innehåller egenskaperna för en av de valda typerna. Om du till exempel skapar en åtgärd för att hämta information om ett tjänstekonto kan du definiera svaret med hjälp av kombinationen oneOf för att antingen få alla egenskaper för Error eller alla egenskaper för ServiceAccountCount.
      Exempel på en polymorfism.
    • anyOf gör att du kan definiera en datatyp som innehåller egenskaperna för en eller flera av de valda typerna. Du kan till exempel definiera en datatyp nervousSystem och en typ skeleton som innehåller olika egenskaper, och använda kombinationen anyOf för att skapa en datatyp som innehåller valfria egenskaper från någon av dessa typer.

      En anyOf-kombination är giltig så länge den innehåller alla obligatoriska parametrar för minst en av de valda datatyperna. Exemplet nedan använder egenskapen brain_weight från typen nervousSystem och egenskaperna skull_height och teeth från skeleton.

      Exempel på en kombination som använder datatyperna nervousSystem och skeleton.

För mer information om sammansättning och polymorfism, se Inheritance and Polymorphism och Difference Between anyOf and oneOf.

Svar

OAS 3.0 gör att du kan definiera nya typer av svar för dina åtgärder:
  • Svarsintervall: istället för att definiera ett svar som 200 kan du ställa in det som 2XX, så att det inkluderar svar från 200 till 299.
  • Standardsvar: du kan definiera ett standardsvar som ska returneras när ett specifikt svar eller svarsintervall inte har definierats.
Svar som definierats med en explicit kod har företräde framför svarsintervall och standardsvar, och svarsintervall har företräde framför standardsvar. I följande exempel:
  • Svaret 204 är definierat och har företräde framför de andra.
  • Svaret 2XX gäller för svarskoderna 200 till 203 och 205 till 299.
  • Svaret default gäller för alla 1XX-, 3XX-, 4XX- och 5XX-svar.
Delavsnitt för svar.

Säkerhet

OAS 3.0 medför nya säkerhetsscheman för ditt API:
  • Bearer-autentisering
  • OpenIdConnect

Begränsningar

OAS 3.0 gör att du kan ange att vissa egenskaper är endast läsbara eller endast skrivbara.

Det här alternativet är endast tillgängligt i datatyper och kan inte definieras i begäranden eller svar på åtgärdsnivå.

Exempel på begränsning.

Var den här sidan till hjälp för dig?

Om du stöter på några problem med den här sidan eller innehållet på den, t.ex. ett stavfel, ett saknat steg eller ett tekniskt fel – meddela oss!

Lämna din feedback här