Datan rakentaminen ominaisuuksien ja additionalProperties-ominaisuuksien avulla

OpenAPI-skeema-direktiivin mukaiset properties ja additionalProperties näytetään objektien muodollisina ominaisuuksina ja sanakirjaominaisuuksina. Jos ne on ilmoitettu property- tai additionalProperties-tyyppein osiossa, OpenAPI-jäsennin ei huomioi jompaa kumpaa. Rekisteröintiprosessi ei jätä virhettä.

OpenAPI-nimetyt properties ovat Apex-ominaisuuksia, joilla on sama nimi ja ominaisuuksien datatyyppi.

OpenAPI-additionalProperties on ryhmitetty Apex-ominaisuuteen, jonka nimi on ominaisuudet ja tyyppi on Map<String, Type>, jossa Type on ilmoitettu additionalProperties-tyyppi. Kartta-ominaisuuden tyyppi on kokoelma avain-arvojen pareja.

OpenAPI-additionalProperties esitetään aina Apex-objektin karttaominaisuutena, vaikka se voitaisiin esittää itsenäisenä Apex Map -tyyppinä. Tuloksena käsitellään yhdenmukaisesti nimetyn objektin ominaisuudet, jotka on määritetty yhdessä additionalProperties-objektin kanssa.

OpenAPI properties ja additionalProperties voidaan molemmat esittää OpenAPI-parametrin skeeman tai skeeman alla määritelmät-osiossa. OpenAPI-jäsennin ei huomioi joko properties tai additionalProperties, jos se esitetään objektin ominaisuustyyppinä. Objektin ominaisuuden tyypin täytyy määrittää vain nimetyt properties tai additionalProperties, mutta ei molempia. Vaihtoehtoisesti voit panna objektin ominaisuuksien määritelmän nimettynä skeemana määritelmät-osioon ja viitata siihen nimen perusteella.

OpenAPI-jäsennin ei erottele literaalisia ilmoituksia tai tyypittämättömiä skeemoja. Lausumia, kuten additionalProperties: true, additionalProperties: false tai additionalProperties: {}, tulkitaan tyypittämättömiksi. Tyypittämättömiä additionalProperties-arvoja ei huomioida. Mitään tyyppisiä additionalProperties-objekteja ei voi ratkaista.

Kulku ei salli Apex-objektityyppien käyttöä tai manipulointia Kartta-ominaisuuksilla, mutta säilyttää sisällön, kun se kohdistetaan saman Apex-objektityypin muuttujiin. Jos haluat manipuloida kartan datarakennetta kulussa, kutsu Apex-kutsuttavaa toimintoa, joka voi käyttää kartan datarakennetta. Esimerkki ulkoisten palveluiden kartoituksista on External Services OpenAPI 2.0 Schema -asiakirjan esimerkissä 9.

Jos luot ulkoisen palvelun rekisteröinnin järjestelmän versiossa 7 tai sitä uudemmassa, voit määrittää ominaisuuden, jonka nimi alkaa numerolla. Kun kyseistä ominaisuutta käytetään kulussa tai Apex, koodausprosessi säätää ominaisuuden nimeä.

{
  "UserAvatarUrls": {
	"type": "object",
	"properties": {
  	  "24x24": {
    	    "type": "string",
    	    "description": "The URL of the user's 24x24 pixel avatar.",
    	    "format": "uri"
  	},
  	  "32x32": {
    	    "type": "string",
    	    "description": "The URL of the user's 32x32 pixel avatar.",
    	    "format": "uri"
  	},
  	  "16x16": {
    	    "type": "string",
    	    "description": "The URL of the user's 16x16 pixel avatar.",
    	    "format": "uri"
  	},
  	  "48x48": {
    	    "type": "string",
    	    "description": "The URL of the user's 48x48 pixel avatar.",
    	    "format": "uri"
  	}
    }
  }
}