APIブループリント｜API Blueprint

API Blueprint. Web API 用の強力な高水準 API 記述言語です。

API Blueprint はシンプルで、API ライフサイクルに関わるすべての人がアクセス可能です。 その構文は、簡潔でありながら表現力豊かです。 API Blueprint を使用すると、作成される API をすばやく設計してプロトタイプ化したり、すでに展開されているミッションクリティカルな API をドキュメント化してテストしたりすることができます。 同時に、API Blueprintツールは、API開発、ガバナンスまたは配信である目標を達成するためのサポートを提供する。

Open

API BlueprintはMITライセンスの下で完全にオープンソースである。 その代わりに、Rust 言語や Django Enhancement Proposal RFC プロセスに似た RFC プロセスを使用します。

貢献するには、API Blueprint RFC リポジトリにプロポーザルを提出します。

At home on GitHub

The API Blueprint language is recognized by GitHub.Search for API Blueprint on GitHub using the language:"API Blueprint" query.

The API Blueprint is text/vnd.apiblueprint, the standard file extension is .apib.The Media Type for API Blueprint is text/vnd.apiblueprint and thestandard file extension is .apib.また、GitHub は API Blueprint を認識します。 この拡張子を使用すると、GitHub 上のブループリントはシンタックスハイライトされます。

Built for better API Designs

API Blueprint は、抽象化を通じてより良い API デザインを奨励するために構築されています。

例えば、データ記述構文を使用して、最初にデータをモデル化します。

# Data Structures## Blog Post (object)+ id: 42 (number, required)+ text: Hello World (string)+ author (Author) - Author of the blog post.## Author (object)+ name: Boba Fett+ email: [email protected]

次に、API エンドポイントでデータを使用および再利用します。 API Blueprint が配置されると、実装が契約で設定された期待に応えているかどうかを誰もがテストできるようになります。

素晴らしいツール

その幅広い採用のおかげで、API Blueprint のために構築された多数のツールがあります。

リストについては、「ツール」セクションを参照してください。

はじめに

API Blueprint を使い始めるには、プレーン テキスト エディターが必要です。 最高の編集体験を得るために、構文の強調表示を Markdown に、または直接 API Blueprint に切り替えます (エディターでサポートされている場合)。

エディターの準備ができたら、API Blueprint チュートリアルに従います。 たとえば、ドキュメントをレンダリングしたり、サービスのモックを生成したり、バックエンド実装のテストを開始したりできます。