Sie befinden sich hier:
OpenAPI 3.0-Schema für externe Services
Dieser Abschnitt umfasst Beispiele zum OpenAPI 3.0-Schema für externe Services.
Erforderliche Editionen
| Verfügbarkeit: Lightning Experience |
| Verfügbarkeit: Enterprise, Performance, Unlimited und Developer Edition |
Beispiel 1: OpenAPI-Basisspezifikation mit Anforderung und Antwort (OAS 3.0)
Im Folgenden finden Sie ein Beispiel einer API-Spezifikation, die ein unterstütztes JSON-Schema für OpenAPI 3.0 enthält. Die Parameter enthalten die Definition für die accountId-Eingabe. Die Antworten enthalten die Definition für die Ausgabe, die creditRating lautet. Parameter, Anforderungen und Antworten entsprechen den Eingaben und Ausgaben für Ihre Flow-Aktionen.
{
"openapi": "3.0.0",
"info": {
"description": "A service for checking credit for an account.",
"version": "1.0.0",
"title": "Credit Decision",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"email": "apiteam@swagger.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"servers": [
{
"url": "https://<YourHostName>"
}
],
"paths": {
"/account/lastCreditRating": {
"get": {
"summary": "Evaluates credit rating and decides what payment terms to offer.",
"description": "",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/accountId"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/accountId"
}
}
},
"description": "Specifies input parameters to calculate payment term",
"required": true
},
"responses": {
"200": {
"description": "success",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/creditRating"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditRating"
}
}
}
},
"405": {
"description": "Invalid input"
}
}
}
}
},
"components": {
"schemas": {
"accountId": {
"type": "object",
"properties": {
"accountIdString": {
"type": "string"
}
},
"xml": {
"name": "accountId"
}
},
"creditRating": {
"type": "object",
"properties": {
"creditRatingString": {
"type": "string"
}
},
"xml": {
"name": "creditRating"
}
}
}
}
}
Beispiel 2: Benannter Objektschemaverweis (OAS 3.0)
Allgemeines Setup
- Weisen Sie der Anmeldeinformation mit Name, die von Ihrer Organisation für den Zugriff auf das Banksystem verwendet wird, die Bezeichnung Bank und einen Platzhalter-URL zu, etwa https://api.example.com zu. Verwenden Sie example.com, da Sie das Schema zur Registrierungszeit einfügen und nicht über einen URL auf eine API-Spezifikation verweisen.
- Registrieren Sie anschließend den externen Service des Mitarbeiterbanksystems. Verwenden Sie den Namen Bank und die Anmeldeinformation mit Namen Bank. Kopieren Sie dann das folgende Schema und fügen Sie es ein.
- Im externen Service des Banksystems werden zwei Möglichkeiten zum Definieren von Parametern mit Objekttypen gezeigt: einen benannten Objekttyp unter einem Block "components/schema" oder einen anonym deklarierten Objekttyp inline.
Hinweis Der definierte oder abgeleitete Objekttypname des Parameters oder eine Eigenschaft mit einem Objekttyp muss weniger als 255 Zeichen umfassen, um in Apex oder Flow Builder verwendet werden zu können.
Hier ein Schema mit dem benannten Objekttyp, der unter dem Block "components/schema" definiert ist. Der Name des Objekttyps "Phone" lautet in Apex oder Flow Builder ExternalService__Bank_Phone.
{
"openapi": "3.0.0",
"info": {
"title": "bankService",
"description": "API description in Markdown.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.example.com/v1"
}
],
"components": {
"schemas": {
"User": {
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"phones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Phone"
}
}
}
},
"Phone": {
"properties": {
"typeofphone": {
"type": "string"
},
"phone": {
"type": "string"
}
}
}
}
}
"paths": {
"/users/{userId}": {
"get": {
"summary": "Returns a user by ID.",
"parameters": [
{
"in": "path",
"name": "userId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
},
"/users": {
"post": {
"summary": "Creates a new user.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}
Beispiel 3: Verschachteltes anonymes Objektschema (OAS 3.0)
Im Folgenden finden Sie eine API-Spezifikation mit einem JSON-Schema, in dem anonyme Objekttypen inline definiert sind. Der Name des abgeleiteten Objekttyps "Phone" lautet ExternalService__Bank_getUsers_OUT_200_phones.
Hinweis Für anonyme Objekttypen leitet Salesforce automatisch Objekttypnamen ab. Die Objekttypnamen basieren auf den Namen des externen Service, des übergeordneten Vorgangs, des Vorgangsparameters, des übergeordneten Objekts und der Objekteigenschaften. Jeder abgeleitete Name muss weniger als 255 Zeichen umfassen. Weitere Informationen finden Sie unter Unterstützung von Schemadefinitionen.
{
"openapi": "3.0.0",
"info": {
"title": "bankService",
"description": "API description in Markdown.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.example.com/v1"
}
],
"paths": {
"/users/{userId}": {
"get": {
"summary": "Returns a user by ID.",
"parameters": [
{
"in": "path",
"name": "userId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"typeofphone": {
"type": "string"
},
"phone": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
},
"/users": {
"post": {
"summary": "Creates a new user.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"phones": {
"type": "array",
"items": {
"type": "object",
"properties": {
"typeofphone": {
"type": "string"
},
"phone": {
"type": "string"
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}
Beispiel 4: Apex-Objektklassenbenennung (OAS 3.0)
Die folgende API-Spezifikation ist mit dem Namen des externen Service "BankingAutomaticTellerMachine" registriert. Die abgeleiteten Objektnamen dürfen jedoch nicht länger als 255 Zeichen sein.
-
ExternalService__BankingAutomaticTellerMachine_VeryImportantCustomer_phone -
ExternalService__BankingAutomaticTellerMachine_getBalanceAccountTypeChecking_OUT_200
Wenn Sie Apex oder Flow Builder verwenden möchten, müssen Sie den Schemanamen des externen Service und das Schema kürzen (in Beispiel 5 gezeigt).
Tipp Wenn der Name des abgeleiteten Objekts länger als 255 Zeichen ist, versuchen Sie, das Problem mit einer der folgenden Methoden zu beheben.
- Kürzen des Namens des externen Service.
- Wenn das Objekt inline unter einem Vorgangsparameter deklariert ist, kürzen Sie den Namen des Vorgangs, indem Sie dem Schema eine operationId hinzufügen.
- Wenn das Objekt inline unter einer übergeordneten Objekteigenschaft angegeben wird, kürzen Sie den Namen des übergeordneten Objekts im Schema.
- Deklarieren Sie das verschachtelte Objekt unter dem Schema "components/schemas" als Objekt der obersten Ebene.
{
"openapi": "3.0.0",
...
"paths": {
"/balance/account/{accountId}/type/checking": {
"get": {
"parameters": [
{
"in": "path",
"name": "accountId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"*/*": {
"schema": {
"type": "object",
"properties": {
"balance": {
"type": "integer"
},
"owner": {
"$ref": "#/components/schemas/VeryImportantCustomer"
}
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"VeryImportantCustomer": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string"
}
}
}
}
}
}
}
}
Beispiel 5: Kürzen von Apex-Objektklassennamen (OAS 3.0)
Im Folgenden finden Sie ein Beispiel einer API-Spezifikation mit einem Schema, das zu Namenskürzungen führt. Es ist mit dem gekürzten Namen "BankAtm" registriert.
Kürzen Sie den Schemanamen des externen Services auf BankAtm, den Schemaobjektnamen auf VIP und fügen Sie operationId als getBalance hinzu:
-
ExternalService__BankAtm_VIP_phone -
ExternalService__BankAtm_getBalance_200
{
"openapi": "3.0.0",
...
"paths": {
"/balance/account/{accountId}/type/checking": {
"get": {
"operationId": "getBalance",
"parameters": [
{
"in": "path",
"name": "accountId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"balance": {
"type": "integer"
},
"owner": {
"$ref": "#/components/schemas/VIP"
}
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"VIP": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string"
}
}
}
}
}
}
}
}
Beispiel 6: Inline-Arrays (OAS 3.0)
Im Folgenden finden Sie ein Beispiel mit einer Inline-Array-Definition.
{
"openapi": "3.0.0",
...
"paths": {
"/employees/{employeeId}": {
"get": {
"operationId": "getEmployee",
"parameters": [
{
"in": "path",
"name": "employeeId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"employee": {
"$ref": "#/components/schemas/Employee"
},
"manager": {
"$ref": "#/components/schemas/Employee"
},
"team": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Employee"
}
}
}
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Employee": {
"type": "object",
"properties": {
"employeeId": {"type": "string"},
"firstName": {"type": "string"},
"middleName": {"type": "string"},
"lastName": {"type": "string"},
"dateOfHire": {"type": "date"}
}
}
}
}
}
Beispiel 7: HTTP-Kopfzeilenparameter (OAS 3.0)
Im Folgenden erfahren Sie, wie ein Header-Parameter in einem OpenAPI-Schema deklariert wird. In Apex oder im Flow wird der Name apiKey als Zeichenfolgenparameter angezeigt. Wenn Sie in Apex oder in einem Flow nun einen Zeichenfolgenwert auf apiKey festlegen, fungiert er beim Senden einer Callout-Anforderung als HTTP-Parameter.
{
"openapi": "3.0.0",
"info": {
"description": "A service for checking credit for an account.",
"version": "1.0.0",
"title": "Credit Decision",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"email": "apiteam@swagger.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"servers": [
{
"url": "https://<YourHostName>"
}
],
"paths": {
"/account/lastCreditRating": {
"get": {
"summary": "Evaluates credit rating and decides what payment terms to offer.",
"description": "",
"parameters": [
{
"name": "apiKey",
"description": "Your API Key for calling the credit rating service",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/accountId"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/accountId"
}
}
},
"description": "Specifies input parameters to calculate payment term",
"required": true
},
"responses": {
"200": {
"description": "success",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/creditRating"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditRating"
}
}
}
},
"405": {
"description": "Invalid input"
}
}
}
}
},
"components": {
"schemas": {
"accountId": {
"type": "object",
"properties": {
"accountIdString": {
"type": "string"
}
},
"xml": {
"name": "accountId"
}
},
"creditRating": {
"type": "object",
"properties": {
"creditRatingString": {
"type": "string"
}
},
"xml": {
"name": "creditRating"
}
}
}
}
}
Beispiel 8: Medientyp im URL-codierten Formular (OAS 3.0)
Die Daten für das Anforderungs- und Antwortformular werden mit dem Medientyp application/x-www-form-urlencoded deklariert.
{
"openapi": "3.0.0",
"info": {
"description": "Apply here for your next mortgage",
"version": "1.0.0",
"title": "My Mortgage Buddy",
"contact": {
"email": "apiteam@swagger.io"
}
},
"servers": [
{
"url": "https://MyMortgageBuddy.org/mortgages"
}
],
"paths": {
"/apply": {
"post": {
"operationId": "applyMortgage",
"requestBody": {
"content": {
"application/x-www-form-urlencoded; charset=utf-8": {
"schema": {
"type": "object",
"properties": {
"terms": {
"description": "Desired mortgage terms",
"type": "array",
"items": {
"type": "integer"
}
},
"fullName": {
"description": "Full Name",
"type": "string"
},
"loanAmount": {
"description": "Loan amount",
"type": "number"
}
},
"required": [
"terms",
"fullName",
"loanAmount"
]
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/x-www-form-urlencoded; charset=utf-8": {
"schema": {
"type": "object",
"properties": {
"formApplicationId": {
"type": "string"
},
"loanOfficerFullName": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
Beispiel 9: allOf- und additionalProperties-Schemadirektiven (OAS 3.0)
In dieser JSON-Schemadefinition wird die Verwendung von allOf für eine Zusammenstellung von Schemaobjekten und additionalProperties für Wörterbuchwerte hervorgehoben. Das Beispielschema ist als externer Service MyBank mit der Anmeldeinformation mit Namen MyBank registriert.
Das Schema definiert einen Bankservice, der Kundendetails für eine Kunden-ID abruft.
- Das Schemaobjekt
Customerverfügt über Wörterbucheigenschaften vom Typ des SchemaobjektsCreditRating. In Apex hat die KlasseExternalService.MyBank_Customerdie Eigenschaftpropertiesvom TypMap<String, ExternalService_CreditRating>mit der Bonität des Kunden. PhonesundEmailshaben eigene Eigenschaften, die mit den gemeinsamenallOf-Eigenschaften des SchemaobjektsContact.zusammengefasst werden
{
"openapi": "3.0.0",
"info": {
"title": "myBank",
"description": "Sample Banking Service with allOf and additionalProperties",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.mybank.com/v1"
}
],
"paths": {
"/customers/{customerId}": {
"get": {
"summary": "Get the customer by ID.",
"parameters": [
{
"in": "path",
"name": "customerId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Customer": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"phones": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Phone"
}
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Email"
}
}
},
"additionalProperties": {
"$ref": "#/components/schemas/CreditRating"
},
"required": [
"id",
"name"
]
},
"Contact": {
"type": "object",
"properties": {
"primary": {
"type": "boolean"
},
"timeOfDay": {
"type": "string"
}
},
"required": [
"primary"
]
},
"Phone": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"typeOfPhone": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
}
}
]
},
"Email": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
}
]
},
"CreditRating": {
"type": "object",
"properties": {
"rating": {
"type": "string"
},
"score": {
"type": "number",
"format": "double"
}
}
}
}
}
}
Informationen zur Verwendung von allOf-Zusammenstellung und additionalProperties finden Sie in Beispiel 9: allOf-Zusammensetzung und Verwendung von additionalProperties in einem Flow mit Apex-Einheitentests.
Beispiel 10: allOf- und Discriminator-Direktiven (OAS 3.0)
Wenn Sie eine allgemeine erweiterbare Liste der Kontakte für einen Kunden angeben möchten, kann die discriminator-Direktive mit allOf kombiniert werden, um zu deklarieren, ob es sich bei einem Kontakt um eine E-Mail oder Telefonnummer handelt:
{
"openapi": "3.0.0",
"info": {
"title": "myBank",
"description": "Sample Banking Service with allOf and discriminator",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.mybank.com/v1"
}
],
"paths": {
"/customers/{customerId}": {
"get": {
"summary": "Get the customer by ID.",
"parameters": [
{
"in": "path",
"name": "customerId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Customer": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
},
"required": [
"id",
"name"
]
},
"Contact": {
"type": "object",
"discriminator": {
"propertyName": "contactType"
},
"properties": {
"contactType": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"timeOfDay": {
"type": "string"
}
},
"required": [
"contactType",
"primary"
]
},
"Phone": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"typeOfPhone": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
}
}
]
},
"Email": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
},
{
"type": "object",
"properties": {
"email": {
"type": "string"
}
}
}
]
}
}
}
}
Entsprechende Informationen zum Verwenden von Zusammensetzungs- und polymorphen OpenAPI-Schemakonstrukten finden Sie unter Beispiel 10: Polymorphie mit allOf und Discriminator.
Beispiel 11: anyOf-, oneOf- und Discriminator-Direktiven (OAS 3.0)
Modelltypen für anyOf- und oneOf mit Teilen eines gemeinsamen Schematyps. anyOf und oneOf können mit dem Schemakonstrukt discriminator für polymorphe Typen kombiniert werden.
- Sozialversicherungsnummer
- Führerscheinnummer
- Vorname und Nachname des Kunden mit optionalen weiteren Vornamen
Im Beispiel kann ein Kunde anhand eines oder mehrerer der folgenden zulässigen Kennzeichner identifiziert werden.
Das Schema legt fest, dass der Vor- und Nachname des Kunden oder andere zulässige Identifikationszeichen ausgewählt werden müssen.
In diesem Beispiel wird auch eine Variante der Polymorphie vom Typ "Kontakt" mit oneOf und discriminator aus Beispiel 10 mit allOf hervorgehoben.
{
"openapi": "3.0.0",
"info": {
"title": "myBank",
"description": "Sample Banking Service with oneOf, anyOf and discriminator",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.mybank.com/v1"
}
],
"paths": {
"/customers/{customerId}": {
"get": {
"summary": "Get the customer by ID.",
"parameters": [
{
"in": "path",
"name": "customerId",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Customer": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"$ref": "#/components/schemas/SSN"
},
{
"$ref": "#/components/schemas/DriversLicense"
},
{
"$ref": "#/components/schemas/FullName"
}
]
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Contact"
}
}
},
"required": [
"id"
]
},
"SSN": {
"type": "object",
"properties": {
"ssn": {
"type": "string"
}
},
"required": [
"ssn"
]
},
"DriversLicense": {
"type": "object",
"properties": {
"dl": {
"type": "string"
}
},
"required": [
"dl"
]
},
"FullName": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"middleName": {
"type": "string"
},
"lastName": {
"type": "string"
}
},
"required": [
"firstName",
"lastName"
]
},
"Contact": {
"oneOf": [
{
"$ref": "#/components/schemas/Phone"
},
{
"$ref": "#/components/schemas/Email"
}
],
"discriminator": {
"propertyName": "contactType"
}
},
"Phone": {
"type": "object",
"properties": {
"contactType": {
"type": "string"
},
"typeOfPhone": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
}
},
"Email": {
"type": "object",
"properties": {
"contactType": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
}
}
}
Informationen zur Verwendung von Zusammenstellungs- und polymorphen OpenAPI-Schemakonstrukten finden Sie in Beispiel 11 (Open API 3.0): AnyOf, OneOf und Discriminator.
Beispiel 12: Rückmeldungen (OAS3.0)
Externe Services geben Rückmeldungsoptionen über das OpenAPI 3.0-Schema-Objekt callbacks an.
Dies ist ein Beispiel einer Rückmeldung für einen Prozess des Hypothekenantrags für das fiktive Unternehmen Acme Mortgages.
openapi: 3.0.0
info:
version: '1.0'
title: Acme Mortgages
description: Acme Mortgages
paths:
# Example of synchronous operation GetApplication
/applications/{applicationNumber}:
get:
operationId: GetApplication
description: Get the mortgage application status and details
parameters:
- name: applicationNumber
in: path
required: true
description: Mortgage Application Number
schema:
type: string
- name: referenceId
in: query
description: Reference ID if applicable. Either as query or header
schema:
type: string
- name: referenceId
in: header
description: Reference ID if applicable. Either as query or header
schema:
type: string
responses:
200:
description: Mortgage application status
content:
application/json:
schema:
$ref: '#/components/schemas/MortgageApplication'
/applications:
# Example of asynchronous operation with callback SubmitApplication
post:
operationId: SubmitApplication
description: Submit a new mortgage application
requestBody:
content:
application/json:
schema:
type: object
properties:
applicant:
$ref: '#/components/schemas/Contact'
object:
$ref: '#/components/schemas/Contact'
statusUpdateRequest:
$ref: '#/components/schemas/ApplicationStatusUpdateRequest'
callbackUrl:
type: object
properties:
outcome:
type: object
properties:
approved:
type: string
rejected:
type: string
documentation:
type: string
outcomeError:
type: string
responses:
200:
description: Mortgage loan application submission response
content:
application/json:
schema:
type: object
properties:
applicationNumber:
type: string
400:
description: Mortgage application error
content:
application/json:
schema:
$ref: '#/components/schemas/MortgageApplicationError'
callbacks:
applicationOutcome:
'{$request.body#/callbackUrl/outcome/approved}':
post:
operationId: ApplicationApproved
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MortgageApplication'
responses:
200:
description: Approved mortgage application callback accepted
'{$request.body#/callbackUrl/outcome/rejected}':
post:
operationId: ApplicationRejected
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MortgageApplication'
responses:
200:
description: Rejected mortgage application callback accepted
applicationDocumentation:
'{$request.body#/callbackUrl/documentation}':
post:
parameters:
- in: query
name: applicationNumber
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MortgageApplicationDocumentation'
responses:
200:
description: Mortgage application documentation callback accepted
applicationStatus_Update:
$ref: '#/components/callbacks/ApplicationStatus_Update'
applicationOutcomeError:
$ref: '#/components/callbacks/applicationOutcomeError'
servers:
- url: '/'
components:
schemas:
MortgageApplication:
required:
- applicationNumber
- status
properties:
applicationNumber:
type: string
status:
description: One of pending, approved, rejected
type: string
requestedAmount:
type: number
approvedAmount:
type: number
appliedOn:
type: string
format: date-time
updatedOn:
type: string
format: date-time
applicant:
$ref: '#/components/schemas/Contact'
object:
$ref: '#/components/schemas/Contact'
ApplicationStatusUpdateRequest:
description: Mortgage application status update request
type: object
properties:
sendStatusUpdates:
type: boolean
statusUpdateCallbackUrl:
type: string
MortgageApplicationDocumentation:
description: Required mortgage documentation
type: array
items:
type: object
properties:
documentType:
type: string
uploadUrl:
type: string
instructions:
type: string
Contact:
type: object
properties:
name:
type: string
address:
type: string
MortgageApplicationError:
properties:
errorMessage:
type: string
applicationNumber:
type: string
callbacks:
ApplicationStatus_Update:
'{$request.body#/statusUpdateRequest/statusUpdateCallbackUrl}':
post:
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
applicationNumber:
type: string
status:
type: string
updateMessage:
type: string
responses:
200:
description: Mortgage application status update callback accepted
applicationOutcomeError:
'{$request.body#/callbackUrl/outcomeError}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MortgageApplicationError'
responses:
200:
description: Mortgage application callback error acceptedBeispiel 13: Hochladen und Herunterladen von Dateien (OAS 3.0)
Diese Spezifikation enthält die folgenden Beispiele:
- Ein PUT-Vorgang für den Datei-Upload: Der PUT-Vorgang verwendet einen
key-Parameter mit dem Speicherort/Dateinamen der hochzuladenden Datei und gibt diecontent-typean. DierequestBodyist als Binärzeichenfolge definiert und enthält den Inhalt der hochgeladenen Datei. - GET-Vorgang zum Herunterladen von Dateien: Der GET-Vorgang verwendet einen
key-Parameter mit dem Dateinamen der herunterzuladenden Datei. Die Antwort 200 gibt eincontent-Objekt zurück, das als Binärzeichenfolge definiert ist, und enthält den Inhalt der heruntergeladenen Datei.
Diese Spezifikation verweist auf das Hochladen einer Datei in Amazon S3. Sie kann jedoch verwendet werden, um Dateien in jedes System hochzuladen, für das Sie Anmeldeinformationen mit Namen konfiguriert haben.
openapi: 3.0.0
info:
title: S3 PutObject and GetObject API
version: 1.1.0
description: Example API for uploading and downloading files to Amazon S3 (without auth headers)
paths:
/{key}:
put:
summary: Upload an object to S3 at the specified key
description: Upload a file to the given bucket and key using HTTP PUT.
operationId: putObject
parameters:
- name: key
in: path
required: true
description: The key (path) of the S3 object
schema:
type: string
- name: Content-Type
in: header
description: MIME type of the uploaded file
schema:
type: string
requestBody:
required: true
content:
application/octet-stream:
schema:
type: string
format: binary
description: Binary content of the file to upload
responses:
'200':
description: Upload successful
headers:
ETag:
description: The ETag of the uploaded object
schema:
type: string
'400':
description: Bad request
'404':
description: Bucket or key not found
'500':
description: Internal server error
get:
summary: Download an object from S3 at the specified key
description: Download the file content from the given bucket and key using HTTP GET.
operationId: getObject
parameters:
- name: key
in: path
required: true
description: The key (path) of the S3 object
schema:
type: string
responses:
'200':
description: File content returned
content:
application/octet-stream:
schema:
type: string
format: binary
'403':
description: Access denied
'404':
description: Object not found
'500':
description: Internal server error
Informationen zur Verwendung dieser Funktion finden Sie unter Beispiel 13 (Open API 3.0): Binärdatei-Upload und Beispiel 13 (Open API 3.0): Binärdatei herunterladen.
Beispiel 14: Enumerationsparameter in Abfragen und Antworten (OAS 3.0)
Diese Spezifikation enthält einen GET-Vorgang, der zwei Enumerationswerte als Parameter verwendet:
- Ein
ItemStatus-Parameter, der einen Wert aus der ItemStatus-Enumeration enthält. - Ein
ItemPriority-Parameter, der einen Wert aus der ItemPriority-Enumeration enthält.
Die Antwort 200 gibt ein Objekt zurück, das die Element-ID, den Status, die Priorität und die Beschreibung enthält.
{
"openapi": "3.0.3",
"info": {
"title": "Enum Examples API",
"version": "1.0.0",
"description": "Example API demonstrating enum parameters in queries and responses."
},
"servers": [
{
"url": "https://abc-mock-api-123456789123.herokuapp.com/"
}
],
"paths": {
"/items": {
"get": {
"operationId": "getItemList",
"summary": "Retrieve a list of items filtered by enum parameters",
"parameters": [
{
"name": "status",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/ItemStatus"
},
"description": "Filter items by their status"
},
{
"name": "priority",
"in": "query",
"required": false,
"schema": {
"$ref": "#/components/schemas/ItemPriority"
},
"description": "Optional filter for item priority"
}
],
"responses": {
"200": {
"description": "Successful response with list of items",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ItemStatus": {
"type": "string",
"enum": [
"active",
"inactive",
"pending",
"archived"
]
},
"ItemPriority": {
"type": "integer",
"enum": [
1,
2,
3,
4,
5
]
},
"ItemResponse": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"status": {
"$ref": "#/components/schemas/ItemStatus"
},
"priority": {
"$ref": "#/components/schemas/ItemPriority"
},
"message": {
"type": "string",
"description": "Additional information about the item"
}
},
"required": [
"id",
"status"
]
}
}
}
}
Konnten Sie Ihr Problem mithilfe dieses Artikels lösen?
Geben Sie uns Feedback, damit wir uns verbessern können.
