Medietypdirektiv och mappning

Direktiven schema utan stöd ogiltigförklarar registrering av API-specifikation.

Schemadirektiv som är inkompatibla med en begärans brödtext eller enhetsschema för svar orsakar fel under anrop.

Du kan registrera specifikationer med medietypdirektiv som inte stöds eller är inkompatibla med consumes, produces eller OpenAPI 3.0 genom att mappa medietyperna till medietyper som stöds. Mer information om medietypmappning finns i Vad är medietypmappning?.

Saknade schemadirektiv blir som standard:

• application/json—om begärans brödtext eller svarets brödtextschema är antingen ett objekt eller en matris
• text/plain—om begäran eller svarsschemats brödtext är av primitiv typ som en sträng eller ett heltalnummer

Om ingen begärandebrödtextparameter har definierats för metoderna POST, PUT och PATCH skickas begärandeparametrar för formulärdata i begärandebrödtexten som application/x-www-form-urlencoded.

Den tillämpliga medietypen i OpenAPI 2.0-listan över produces, OpenAPI 3.0-typer för response eller en standard (application/json eller text/plain) är inställd som HTTP-acceptrubriken.

Vad är medietypmappning?

Du kan mappa varje egen medietypinstans som inte stöds (definierad i din API-specifikation) till en medietyp med samma format. Mediatyper som stöds för både begäranden och svar är:

• application/json—Strukturerade data i JSON-format.
• text/plain—Ostrukturerade data som klartext.
• application/x-www-form-urlencoded—URL-kodat formulär.

Till exempel, om din specifikation innehåller en anpassad application/abc.api+json av medietyp och formateringen följer standard JSON-formatering, mappa denna egna medietyp till application/json.

Du kan utföra denna mappning antingen genom att mappa medietyper under registrering (det deklarativa, enkla sättet) eller genom att mappa medietyper med Metadata API (vilket innefattar manuell kodning).

Egna medietyper med ett suffix för medietyp som stöds känns igen som en av de kompatibla medietyper som stöds. Till exempel känns en egen medietyp application/vnd.api+json eller leverantörs medietyp med medietypsuffixet json igen som application/json.

Medietypsuffix som stöds är:

• json—Strukturerade data i JSON-format.

Mer information om schemadirektiv för OpenApi 2.0 consumes/produces eller OpenAPI 3.0 content finns i Stöd för schemadefinition.