Medietypedirektiver og tilknytning

Ikke-understøttede skema-direktiver gør API-specifikationregistreringen ugyldig.

Skemadirektiver, der er inkompatible med en anmodningsbrødtekst eller erklæring for svarenhedsskema, forårsager fejl under udkald.

Du kan registrere specifikationer med ikke-understøttede eller inkompatible consumes, produces eller OpenAPI 3.0-indholdsmedietypedirektiver ved at tilknytte medietyper til understøttede medietyper. Hvis du ønsker flere oplysninger om medietypetilknytning, kan du se Hvad er medietypetilknytning?

Manglende skemadirektiver er som standard:

• application/json – hvis anmodningsbrødteksten eller svarbrødtekstskemaet enten er et objekt eller en matriks
• text/plain – hvis anmodningen eller svarskemaets brødtekst er en primitiv type som en streng eller et heltalsnummer

Hvis der ikke er defineret nogen parameter for anmodningsbrødtekst for metoderne POST, PUT og PATCH, sendes parametrene for formulardataanmodninger som application/x-www-form-urlencoded.

Den relevante medietype på OpenAPI 2.0 produces listen, OpenAPI 3.0 response skema medietyper eller en standard (application/json eller text/plain) indstilles til HTTP Accept-sidehovedet.

Hvad er Medietypetilknytning?

Du kan tilknytte hver ikke-understøttet, tilpasset medietypeforekomst til en understøttet medietype i samme format. Understøttede medietyper for både anmodninger og svar er:

• application/json – Strukturerede data i JSON-format.
• text/plain – Ustrukturerede data som almindelig tekst.
• application/x-www-form-urlencoded – URL-kodet format.

Hvis f.eks. din specifikation inkluderer en tilpasset medietype application/abc.api+json, og formateringen overholder standard-JSON-formatering, skal du tilknytte denne tilpassede medietype til application/json.

Du kan udføre denne tilknytning ved enten at tilknytte medietyper under registrering (den deklarative, nemme måde) eller ved at tilknytte medietyper med Metadata API (som involverer manuel kodning).

Tilpassede medietyper med et understøttet medietypesuffiks genkendes som en af de kompatible understøttede medietyper. F.eks. genkendes en tilpasset eller leverandørmedie type application/vnd.api+json med medietype suffiks json som application/json.

Understøttede medietypesuffikser:

• json – Strukturerede data i JSON-format.

Hvis du ønsker oplysninger om OpenApi 2.0 consumes/produces eller OpenAPI 3.0 content medietypeskemadirektiver, kan du se Skemadefinitionsunderstøttelse.