Afficher : Delphi C++
Préférences d'affichage

Ressource API EMS

De RAD Studio

Remonter à API administrative EMS


La ressource API offre la documentation de l'API EMS aux formats YAML et JSON.

Pour accéder à la documentation API :

  • Format YAML : localhost:8080/api/apidoc.yaml
  • Format JSON : localhost:8080/api/apidoc.json

Points de terminaison de ressource API

La ressource API expose les points de terminaison de ressource EMS suivants :

Nom de méthode du point de terminaison Suffixe de ressource Type de requête HTTP Utilisation Chemin

API

--

HTTP GET

Pour récupérer tous les points de terminaison API.

/api

Point de terminaison GetAPIYAMLFormat

{item}/apidoc.yaml

HTTP GET

Pour récupérer un point de terminaison pour les points de terminaison API.

/api/{item}/apidoc.yaml

GetAPIYAMLFormat

apidoc.yaml

HTTP GET

Pour obtenir la documentation API au format YAML.

/api/apidoc.yaml

GetAPIJSONFormat

apidoc.json

HTTP GET

Pour obtenir la documentation API au format JSON.

/api/apidoc.json

Point de terminaison API

Renvoie tous les points de terminaison API.

En cas de réussite, la réponse du serveur EMS fournit la liste de tous les appels API disponibles :

[{"apicall":"apidoc.yaml"},{"apicall":"apidoc.json"}]

Point de terminaison GetAPIYAMLFormat

Renvoie la documentation API pour la ressource spécifiée au format YAML.

En cas de réussite, la réponse du serveur EMS fournit la documentation API pour la ressource sélectionnée au format YAML.

Exemple de réponse

Voici la réponse de la requête de la documentation API de la 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

Renvoie la documentation API entière au format YAML.

GetAPIJSONFormat

Renvoie la documentation API entière au format JSON.

Voir aussi

Outils personnels
Autres langues
Versions précédentes