OpenAPIでAPIを素早く簡単に評価する

Nexmoでは、すべてのAPIについてOpenAPI仕様を公開しています。これにより、開発者の皆様は、当社のAPIを探索、評価し、ご自身のアプリケーションに統合することが容易になります。OpenAPIについての詳細と、API仕様を開発者と共有する理由については、こちらをお読みください。

OpenAPIとは？

OpenAPIはAPIを記述するための機械可読な方法である。YAMLまたはJSONで記述され、APIの全体的な目的、認証メカニズム、その他の詳細を記述する（Swaggerをご存知なら、OpenAPIはその後継である）。また、APIの各エンドポイントについても詳細に記述されている。例えば、これは Account API からの抜粋で、Nexmo 口座の残高を確認する方法を示しています：

/account/get-balance:
    servers:
      - url: "https://rest.nexmo.com"
    get:
      operationId: getAccountBalance
      summary: Get Account Balance
      description: Retrieve the current balance of your Nexmo account
      parameters:
        name: api_key
        description: Your Nexmo API key. You can find this in the [dashboard](${CUSTOMER_DASHBOARD_URL})
        in: query
        required: true
        schema:
          type: string
          example: abcd1234
        name: api_secret
        description: Your Nexmo API secret. You can find this in the [dashboard](${CUSTOMER_DASHBOARD_URL})
        in: query
        required: true
        schema:
          type: string
          example: ABCDEFGH01234abc

見ての通り、APIの記述形式は非常に冗長だ。それは、機械でも理解できるようにAPIをうまく記述する必要があるからだ。ここに示したサンプルには、口座残高に関する情報を取得するのに必要なURL、動詞、パラメータが記述されている。この仕様ではまた、成功したものとそれ以外のものの両方について、返される可能性のあるレスポンスのステータスとペイロードを記述する方法も提供している！

OpenAPI仕様書のダウンロード

OpenAPI仕様はAPIプロバイダー企業内で広く使われている。機械可読の仕様は開発サイクルにおいて非常に強力で、自動コード生成、テスト、ライブラリSDKを可能にする。

しかし、OpenAPI仕様は、APIプロバイダー自身の組織の外で広く共有されることで、さらに有用になる。それは最新のAPIプラクティスの良い指標であり、情報を探して見慣れないドキュメントを読み漁るよりも、自分のツール内で使うために標準フォーマットのファイルを手に入れる方がずっと早い。我々は、多くのAPIプロバイダーが彼らのAPIにOpenAPI仕様を提供しているのを見ており、とても気に入っている。）

Nexmo APIリファレンスページを見ると、このようなボタンがあります：

A big blue Download OpenAPI 3 Description button

APIリファレンスドキュメントはOpenAPI仕様そのものから生成され、ダウンロードボタンをクリックするとソースのYAMLファイルが得られます。ダウンロードボタンをクリックすると、ソースの YAML ファイルが得られます。 GitHub.

PostmanでAPIを探る

見たことのないOpenAPIファイルをインポートするのが私たちのお気に入りだ。 ポストマン.この素晴らしいツールをまだご存知でない方は、APIを扱うときに本当に便利なHTTPクライアントです（実際にはそれ以上のものなので、ご自身で調べてみてください）。

PostmanがOpenAPI v3ファイルをサポートしました。コレクション作成時にファイルをインポートできます：

Shows the import dialog when creating a collection

OpenAPI仕様をインポートすると、APIリクエストの既製の「コレクション」が作成され、個々のエンドポイントには、すでにあなたのためのリクエストが作成されている。APIキーやシークレット、その他このリクエストに必要なパラメータをすぐに追加して実行することができます。

check balance postman

これは、馴染みのないAPIを探索するのにとてもスピーディーな方法だと思う。ドキュメントを読んだり、APIコールの例を組み合わせたりして、このAPIが自分のニーズに合うかどうかを調べるよりも、すべてが目の前にある。

プロからのアドバイスNexmo APIで今すぐお試しください。そのためには アカウント登録が必要です。が必要ですが、無料クレジットが少し付いてきますのでご安心ください。

独自のSDKを作成する

Nexmoでは、6つ半の異なる技術スタックのサーバーSDKを公開しています。しかし、すべてのAPIプロバイダーがそうとは限りませんし、あなたが探していたプログラミング言語を提供していないかもしれません。しかし、すべてのAPIプロバイダーが提供しているわけではありませんし、お探しのプログラミング言語が提供されていない場合もあります。まともなSDKと、まったく提供されていないSDKの中間として、コードジェネレーターを使ってAPIの基本的なラッパーを作成することができます。の "SDK Generators "セクションをチェックしてください。 https://openapi.tools/#sdkの "SDK Generators "セクションをチェックしてください。

本物の」SDKか生成されたSDKのどちらかを持つことで、API統合をかなりスピードアップできます。IDEでオートコンプリート機能を使えば、ステップごとにドキュメントで調べるよりもずっと速くなります。APIの一部分だけのためにSDKを生成することは、依存関係を少なくしたり、コードベースを小さくしたりすることにもつながり、状況によってはそれは本当に重要だ。OpenAPI仕様を提供してくれるAPIプロバイダーを選択することは、そのようなシナリオで非常に役に立つ。

編集部注：OpenAPIについてもっと知る

OpenAPIについてご興味のある方は、以下のイベントにご参加ください。 Vonage Campus イベントに来てみませんか？ローナ（この記事の著者）もOpenAPIについて講演する予定です - 彼女はOpenAPI全般についておしゃべりするのが大好きなので、Nexmoの人たちと一緒にAPIについて話す絶好の機会です。