Standardverdier og standardverdier
Finn ut mer om Støtte for eksterne tjenester for standardinnstillinger. For OpenAPI 2.0 brukes standardverdier angitt på properties. For OpenAPI 3.0-skjemaer brukes standardverdien "outermost". Konfigurasjoner som ikke støttes, ignoreres.
Nødvendige utgaver
| Tilgjengelig i Lightning Experience |
| Tilgjengelig i Enterprise, Performance, Unlimited og Developer Edition |
Standardverdier
For både OpenAPI 2.0- og 3.0-spesifikasjoner:
- Typen standardverdi må samsvare med typen egenskap/parameter. Hvis typen for eksempel er
integerog standardverdien er50.2, oversettes ikke standardverdien til Apex. - Hvis
integer-standarder skal vises, må det angis et format, for eksempelint32ellerint64.
Følgende deler beskriver Open API-versjonsspesifikk støtte for standardverdier.
Standard OpenAPI 2.0-definisjoner
For OpenAPI 2.0-skjemaer støtter Eksterne tjenester et delsett av primitive datatyper for standardverdier angitt i objektegenskaper. Disse primitive datatypene er begrenset til:
- streng
- tall
- heltall
- boolsk
For OpenAPI 2.0-skjemaer brukes bare standardverdiene som er angitt i properties.
I kodesnutten nedenfor støttes for eksempel standardinnstillingen for month-egenskapen. I Apex ser du en kommentar i fødselsdagsobjektet med
// Default value: January
Standardverdien som er angitt på objektnivå,
"default": { "month": "December" }
ignoreres.
"birthday": {
"type": "object",
"properties": {
"month": {
"type": "string",
"default": "January"
},
"day": {
"type": "integer"
},
"year": {
"type": "integer"
}
},
"default": {
"month": "December"
}
}Standardverdier som er angitt andre steder enn i egenskapen (som object/composed object), ignoreres.
I følgende eksempel er standardverdien 123 fordi det er det som angis for egenskapen.
"Fax": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"faxNumber": {
"type": "integer",
"default": 123
}
}
},
{
"default": {
"faxNumber": 456
}
}
],
"default": {
"faxNumber": 789
}
}Standard OpenAPI 3.0-definisjoner
For OpenAPI 3.0-skjemaer brukes den ytterste default. For det samme fødselsdagsobjektet som er registrert med et OAS3-skjema:
"birthday": {
"type": "object",
"properties": {
"month": {
"type": "string",
"default": "January"
},
"day": {
"type": "integer"
},
"year": {
"type": "integer"
}
},
"default": {
"month": "December"
}
}kommentaren i Apex er
// Default value: December
fordi default-settet på objektnivået er det ytterste, og er derfor det som brukes.
Standardinnstillinger angitt på sammensatt objektnivå for anyOf- og oneOf-objektsammensetninger støttes ikke. I følgende eksempel:
"default": { "phoneNumber": "1 (000) 000 0000"
brukes ikke.
"Phone": {
"oneOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"phoneNumber": {
"type": "string"
}
}
}
],
"default": {
"phoneNumber": "1 (000) 000 0000"
}
}Standardinnstillinger angitt på det sammensatte objektnivået for allOf støttes imidlertid. Igjen i dette scenariet overstyrer standardverdiene "den ytterste" de andre. Hvis det eneste standardsettet for faksobjektet nedenfor var 123, vises dette i Apex-klassen. Men hvis både 123 og 456 er angitt, vil 456 overstyre 123 og 456 vises i Apex-klassen, og på samme måte hvis 123, 456, 789 alle er angitt, vil 789 vises i Apex-klassen.
"Fax": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"faxNumber": {
"type": "integer",
"default": 123
}
}
},
{
"default": {
"faxNumber": 456
}
}
],
"default": {
"faxNumber": 789
}
}