Platform API の JSON スキーマ

最終更新日 2023年04月07日(金)

Table of Contents

Heroku Platform API には、コンピュータで判読可能な JSON スキーマがあります。このスキーマは、API を通じて利用可能なリソース、リソースの URL、リソースの形式、リソースでサポートされている操作を記述します。スキーマのユースケースの例には、以下のものがあります。

  • 任意のプログラミング言語用のクライアントライブラリの自動作成
  • 最新のリファレンスドキュメントの生成
  • 自動の受け入れテストおよび統合テストの作成

このスキーマを使用して、いくつかの Platform API クライアントライブラリがすでに生成されています。

形式

Heroku では、JSON スキーマ​を使用して Platform API を記述します。ドラフト段階の Validation​ および Hypertext​ 拡張標準も使用されます。

JSON スキーマは、Swagger および Google API Discovery Service​ の基礎としても使用されます。JSON スキーマの Web サイトにある多数のリソースとリンク​から概要を理解できます。

使用方法

この API は、HTTP を使用して独自の JSON 形式スキーマを提供します。

$ curl https://api.heroku.com/schema  -H "Accept: application/vnd.heroku+json; version=3"
{
  "description": "The platform API empowers developers to automate, extend and combine Heroku with other services.",
  "definitions": {
  ...
  }
}

スキーマの使用方法の例については、前述したクライアントライブラリを参照してください。