){kind=small}
OpenAPIが統合を容易にする
所要時間：1 分
私たちは 開発者向けドキュメント特に APIリファレンス.リファレンス・ドキュメントは、各APIの機械可読な記述から生成されます。 OpenAPIフォーマットで作成されています。テキストベースの機械可読フォーマットで作業することで、ドキュメントのメンテナンスが容易になります。ドキュメントの管理者である私たちにとっては素晴らしいことですが、ユーザーであるあなたにはどのように役立つのでしょうか？よくぞ聞いてくれました！
APIリファレンスページを見てください。そこに "Download OpenAPI 3 Specification "と書かれたボタンがあり、それをクリックすればYAMLの贈り物を受け取ることができます。また、すべての仕様書は definitions/フォルダにもあります。 API Specifications GitHub リポジトリ.
OpenAPIのような標準的なAPI記述フォーマットを使うことで、これらのファイルを理解する様々なツールにアクセスすることができます。OpenAPI仕様を使ってできることで、私が気に入っていることをいくつか紹介しよう！
馴染みのないAPIを試しているとき、特定のリクエストのまとめ方を理解するためにドキュメントを調べようとするとイライラすることがある。PostmanはOpenAPI仕様ファイルのインポートをサポートしており、それらをAPIリクエストのレディーメイド集に変えてくれる。これは、ドキュメントを読んだり、フィールド名をHTTPクライアントにコピーしたりするのに多くの時間を費やすことなく、新しいAPIを試す素晴らしい方法だ。
私はこのアプローチの大ファンで、目隠しをしてもcurlコマンドを打てるほどよく知っているAPIでも、非常に頻繁に使っている。APIと正しくやりとりするための迅速な方法であり、とても役立っている。
旅行中、信頼できるインターネットに接続できないことがある。もしOpenAPIのスペックファイルがローカルにあれば（ネタバレ：スペックファイルは常にローカルにある。
1つの選択肢は、私たち自身が使っているツールを使うことです。 Nexmo OASレンダラー.これはRubyベースのオープンソースのツールで、私たち自身で作成し公開しています。私たち自身のAPIに使うことがほとんどですが、有効なOpenAPI v3の仕様ファイルであれば、どんなものでも動作するはずです。
私がときどき使うもうひとつのアプローチは、オープンソースのツールで、今度はNodeJSの ReDoc.ここでも、OpenAPI仕様からHTMLドキュメントを作成するのに便利だ。両方のオプションを試してみて、好みのものを選んでください！
APIの説明にはAPIのあらゆる側面に関する情報がある。実際、含まれているすべての詳細で、そのAPIの非常に良い物まねができるほど多くの情報がある。
OpenAPI仕様のAPIを非常にうまく模倣している。 StoplightのPrismが提供しているものだ。これはNodeJSツールだ。 npmでインストールし、ローカルで起動すれば、OpenAPI仕様ファイルからAPIを自分用にコピーすることができる！
同じAPIエンドポイントを何度も呼び出す可能性がある開発では、様々なレスポンスを正しく処理していることを確認するために、これを最もよく使う。モックサーバーはリモートAPIよりも高速で よりも高速でよりもずっと安い。レート制限もない。APIと統合する人にとって、モック・サーバーのようなツールは大きな後押しとなる。APIプロバイダーである私たちにとって、人々が安全な空間で統合を開発できるようにサンドボックスを構築したりサポートしたりする必要はない。
APIプロバイダがOpenAPI仕様を公開することで、APIユーザに大きな違いをもたらすと私が感じるものを3つ選んでみた。VonageはAPIの説明を公開することに関して特に目立っているわけではない。私はほとんどの最新のAPIプロバイダーが同じことをすると期待している。うまくいけば、次のAPI統合を改善するために何を試したいか、いくつかアイデアが浮かんだだろう。これらのアプローチのいずれかをすでに使っている場合、あるいは次に試してみたいものがあれば教えてほしい。
OpenAPIと私たちのツールについて興味がありますか？ここに、さらに詳しい情報があります：
OpenAPIイニシアチブ https://www.openapis.org
OpenAPIで使うツールを探すのに最適な場所： https://openapi.tools
使用するリクエストのコレクションを作るためにスペックをインポートするための Postman： https://postman.com
モックサーバーのプリズム https://stoplight.io/open-source/prism
PostmanとPrismの使用に関するより詳細な情報、ドキュメントの生成など、OpenAPIに関するより多くのVonage固有のドキュメント： /getting-started/concepts/openapiをご覧ください。