RAD Server-Ressource "API"
Nach oben zu RAD Server Administrative API
Die API-Ressource stellt die Dokumentation der EMS-API im YAML- und JSON-Format bereit.
So greifen Sie auf die API-Dokumentation zu:
- YAML-Format:
localhost:8080/api/apidoc.yaml
- JSON-Format:
localhost:8080/api/apidoc.json
Inhaltsverzeichnis
Endpunkte der API-Ressource
API-Ressource stellt die folgenden EMS-Ressourcenendpunkte bereit:
Name der Endpunktemethode | Ressourcensuffix | HTTP-Anforderungstyp | Verwendung | Pfad |
---|---|---|---|---|
API |
-- |
HTTP GET |
Zum Abrufen aller API-Endpunkte. |
|
GetAPIYAMLFormat EndPoint |
|
HTTP GET |
Zum Abrufen eines Endpunktes für die API-Endpunkte. |
|
GetAPIYAMLFormat |
|
HTTP GET |
Zum Abrufen der API-Dokumentation im YAML-Format. |
|
GetAPIJSONFormat |
|
HTTP GET |
Zum Abrufen der API-Dokumentation im JSON-Format. |
|
API-Endpunkt
Gibt alle API-Endpunkte zurück.
Bei Erfolg enthält die Antwort vom EMS-Server eine Liste der möglichen API-Aufrufe:
[{"apicall":"apidoc.yaml"},{"apicall":"apidoc.json"}]
GetAPIYAMLFormat EndPoint
Gibt die API-Dokumentation für die angegebene Ressource im YAML-Format zurück.
Bei Erfolg enthält die Antwort vom EMS-Server die API-Dokumentation für die ausgewählte Ressource im YAML-Format.
Beispielantwort
Dies ist die Antwort auf die Anforderung der API-Dokumentation der Ressource Version.
localhost:8080/api/version/apidoc.yaml
---
swagger: '2.0'
info:
version: 0.0.0
title: EMS API Documentation
description: |
Enterprise Mobility Services API
[Learn about EMS](https://www.embarcadero.com/products/rad-studio/enterprise-mobility-services)
EMS (Enterprise Mobility Services) offers a Mobile Enterprise Application Platform (MEAP)
TurnKey Middleware for Interconnected Distributed Apps
host: localhost:8080
basePath: /
schemes:
- http
paths:
/version:
get:
tags:
- Version
summary: "Get version"
description: |
Used to retrieve the `Version` of the EMS Server.
operationId: GetVersion
produces:
- application/json
parameters:
- in: header
description: Header used by the EMS server
name: X-Embarcadero-Application-Id
type: string
- in: header
description: Header used by the EMS server
name: X-Embarcadero-App-Secret
type: string
- in: header
description: Header used by the EMS server
name: X-Embarcadero-Master-Secret
type: string
responses:
200:
description: Ok. Provides the current version of the EMS Server
schema:
$ref: '#/definitions/versionObject'
definitions:
#
versionObject:
type: object
properties:
version:
type: string
server:
type: string
GetAPIYAMLFormat
Gibt die gesamte API-Dokumentation im YAML-Format zurück.
GetAPIJSONFormat
Gibt die gesamte API-Dokumentation im JSON-Format zurück.