RAD サーバー API リソース
RAD サーバー管理用 API への移動
API リソースでは、EMS API のドキュメントを YAML 形式および JSON 形式で提供します。
API ドキュメントにアクセスするには:
- YAML 形式:
localhost:8080/api/apidoc.yaml
- JSON 形式:
localhost:8080/api/apidoc.json
目次
API リソース エンドポイント
API リソースでは、次の EMS リソース エンドポイントを公開しています。
エンドポイント メソッド名 | リソース サフィックス | HTTP 要求の種類 | 用途 | パス |
---|---|---|---|---|
API |
-- |
HTTP GET |
すべての API エンドポイントを取得すること。 |
|
GetAPIYAMLFormat EndPoint |
|
HTTP GET |
1 つの API エンドポイントを取得すること。 |
|
GetAPIYAMLFormat |
|
HTTP GET |
YAML 形式の API ドキュメントを取得すること。 |
|
GetAPIJSONFormat |
|
HTTP GET |
JSON 形式の API ドキュメントを取得すること。 |
|
API エンドポイント
すべての API エンドポイントを返します。
正常終了した場合、EMS サーバーからの応答には、使用可能な API 呼び出しのリストが次のように含まれます。
[{"apicall":"apidoc.yaml"},{"apicall":"apidoc.json"}]
GetAPIYAMLFormat EndPoint
指定されたリソースの API ドキュメントを YAML 形式で返します。
正常終了した場合、EMS サーバーからの応答には、選択したリソースの API ドキュメントが YAML 形式で含まれます。
応答の例
次に示すのは、Version リソースの API ドキュメントを要求したときの応答です。
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
API ドキュメント全体を YAML 形式で返します。
GetAPIJSONFormat
API ドキュメント全体を JSON 形式で返します。