オープンAPI

オープンAPI はAPIを記述するための業界標準仕様です。私たちはOpenAPIを使って を使用しており、その仕様も公開しています。

OpenAPI仕様の検索

各製品にはそれぞれOpenAPIの仕様があります。それを見つける最も簡単な方法は、APIリファレンスから見つけることです。 ページの一番上にある "Download OpenAPI Specification "からAPIリファレンスをダウンロードできます。APIリファレンスのページ自体は、これらの仕様書から生成されています。 これらの仕様書から生成されます。

各仕様には、以下の両方が用意されている。 ヤムル そして JSON プレーンテキストエディターで表示できます。

自分のプロジェクトでOpenAPI仕様を使う

統合したいAPIのOpenAPI記述を持っていると、本当に楽になる！以下は を試してみてください：

ローカル・ドキュメンテーション

OpenAPI仕様には、ローカルアプリケーションを実行してドキュメントを表示するために必要なすべての情報が含まれています。 ReDoc は、API仕様を閲覧するために使用できるオープンソースのドキュメントツールの一例である。

ポストマンコレクション

もしあなたがすでに ポストマン そうでなければ、ぜひ試してみてほしい。そうでないなら をお試しあれ。

1. 興味のあるAPIの仕様書をダウンロードする（APIリファレンスページから）
2. Postmanで "Import "をクリックし、"Import "ボタンをクリックします。 *.yml ダウンロードしたファイル

これで完了です。APIに対して行うリクエストの準備ができました。 これで完了です！

Prismでテストするためのモック・サーバー

多くの開発者が重宝しているツールのひとつが、次のものだ。 プリズム.これはオープンソースの JavaScriptツールで、OpenAPIの仕様を受け入れ、その仕様が記述するAPIの動作を模倣する。ローカルのAPIで作業するには理想的な方法だ。 ローカルAPIで作業する理想的な方法であり、何かをテストしているときにAccountのクレジットを使い果たすことを避けられる。 レスポンスをローカルでテストする方法も提供する。