郵便配達員:API開発とテストを簡素化するための強力なツール
キーポイント:
ジェフ・スミスの助けをありがとう、彼はこの記事のピアレビューに参加することに熱心でした。
今日のSitePoint Webサイトで人気のある記事:
API(アプリケーションプログラミングインターフェイス)は、アプリケーション間の相互作用の媒体です。 HTTPまたはHTTPSを使用するAPIは、Web APIと呼ばれます。
インターネットを見回すと、多数のサービスがAPIを使用していることがわかります。ソーシャルログインを使用すると、eコマースWebサイトのモバイルアプリケーションが使用されています。
サービスのAPIを作成することにより、サードパーティの開発者がサービスに基づいてアプリケーションを作成できるようにすることができます。たとえば、ソーシャルニュースサイトのFrroleは、Twitter APIを使用して、多数のツイートを分析することにより、コンテキストの洞察を生成します。
APIを作成することの長所と短所を評価したと仮定して、APIを作成およびテストするプロセスについて簡単に説明しましょう。
APIを作成するには多くの方法がありますが、Web APIは残りの(概念状態転送)フレームワークを使用して作成されます。 RESTフレームワークは、APIを作成するときに従う必要がある一連のガイドラインを指定します。毎日作成された多数のAPIにより、WebベースのAPIの標準になります。
APIを通じて実行される4つの最も一般的な操作は、オブジェクトの表示、作成、編集、削除です。 RESTフレームワークは、これらの操作に4つのHTTP動詞をマッピングします:取得、投稿、配置、削除。このリストには、パージやパッチなどの多くの動詞が追加されていますが、この記事では4つの基本動詞のみを説明します。 Enchant.comの創設者Vinay Sahniによって書かれた実用的なRestful APIベストプラクティスに関する記事は、初めての開発者にとって役立つかもしれません。
今日の多くのフレームワークは、基本的なHTTPレイヤーのラッパーを提供し、開発作業を容易にします。必要なコマンドまたは関数を呼び出して関数に焦点を合わせるだけです。人気のある例には、SlimとToro、2つのPHPベースのミニチュアフレームワークがあり、REST APIをすばやく作成するのに役立ちます。
APIを作成する主な目的は、他のアプリケーション(おそらく独自または第三者が開発した)を有効にすることです。したがって、API開発プロセスのあらゆる段階で、重要なステップは、APIの機能、例外処理、セキュリティをテストすることです。
APIを使用するには、動詞(またはメソッド)のいずれかを使用して、目的のリソース(通常はURL)にリクエストを行うことが含まれます。使用しているAPIの要件に応じて、ヘッダーを追加する必要がある場合があります。そのようなリソースを要求する1つの方法は、コマンドラインを使用することです。
この記事では、API呼び出しの4つの部分(URL、HTTP動詞、ヘッダー、およびパラメーター)に焦点を当てます。 Curlライブラリを使用して、CLIを介してAPIリソースにリクエストを送信します。 Curlは、URL構文を使用してデータを転送するのに役立つコマンドラインツールです。FTP、FTPS、HTTP、HTTPSをサポートしています。次のコマンドを見てみましょう
-iコマンドは、リクエストにヘッダーが存在することをコマンドに伝えるincludeの略です。 -xオプションは、HTTP動詞またはメソッドにすぐに従います。 -hリクエストに追加されたカスタムヘッダーを指定します。最後に、-dオプションは、リクエストに合わせて渡されるカスタムフォームデータを指定します。
<code>curl -i -X POST -H "Content-Type:application/json" http://www.my-api-example.com:port/ -d '{"Name":"Something"}'</code>
API呼び出しの結果は、通常はJSON形式でエンコードされるHTTP応答です。応答には、リクエストステータスに関する情報を提供するHTTP応答コードが提供されます(例:200はOK、404はリソースが存在しないことを意味し、500はサーバーエラーを意味し、403はリソースが禁止されていることを意味します)。たとえば、以前のリクエストの結果として、次の回答を送信できます。
コマンドライン内でそのような応答をテストすることは、特に応答に多数のオプションがある場合、チャレンジをもたらします。CodingPediaのこの詳細なガイドは、APIをテストするときにCLIオプションリストをリストします。
<code>{"message":"success","id":"4"}</code>
Postman
によるテストを簡素化しますPostmanは、API開発プロセスを高速かつ簡単にする強力なAPI開発キットです。 Mac、Windows、LinuxのChrome拡張機能およびネイティブアプリケーションとして使用できます。 100万人以上の開発者がそれを試しました。 Chrome拡張機能をインストールするには、最初にChromeをインストールしてから、Chrome Webストアのプロジェクトページに移動する必要があります。
プレビュー(応答がHTMLの場合)に加えて、リクエストを通じて受け取る応答は、元の形式または美しい形でも表示できます。次の画像は、ポストマンで応答を表示するさまざまな方法を示しています。
Postmanは、過去に作成したAPIコールを自動的に保存します。これにより、APIをテストするときに時間を節約できます。さらに、それらはあなたの便利さのために関連するAPI呼び出しにグループ化できます。これは、Postmanを介したAPIコール履歴の例です。
グラフAPIを使用する場合、アクセストークンが重要です。トークンは多くの権限に関連付けられています。たとえば、publish_actionsがトークンを生成するときに選択されたフィールドの1つである場合にのみ、トークンを使用して投稿を作成できます。この追加レベルのセキュリティは、Facebookを介してログインするときに特定のアプリケーションに特定のアクションを付与するのに役立ちます。
投稿を表示
次の画像は、詳細とともに基本的なグラフAPI呼び出しを示しています。
<code>curl -i -X POST -H "Content-Type:application/json" http://www.my-api-example.com:port/ -d '{"Name":"Something"}'</code>
コマンドに従って、タイムラインの投稿のリストを確認できます。
タイムラインの投稿リストの詳細がどのように表示されるかを次に示します。
<code>{"message":"success","id":"4"}</code>
単一の投稿の詳細は次のとおりです。
like
<code>GET /me/</code>
次のように、郵便配達員を介して同様のリクエストを送信します
投稿を作成します
<code>GET /me/feed/</code>
投稿を作成するには、POSTリクエストに加えていくつかのパラメーターを送信する必要があります。これを行うには、publish_actionsも必要です。
次のオプションを投稿リクエストに追加できます:
ドキュメントでは、これらすべての機能がどのように使用されるかを説明しています。
自分のタイムラインまたはユーザー、ページ、イベント、またはリクエストを送信することを選択したURLに基づいてのタイムラインに投稿を作成できます。
<code>curl -i -X POST -H "Content-Type:application/json" http://www.my-api-example.com:port/ -d '{"Name":"Something"}'</code>
投稿を編集するには、次のURLにPOSTリクエストを送信し、投稿を作成したときと同じパラメーターを使用する必要があります。
投稿を削除
<code>{"message":"success","id":"4"}</code>
<code>GET /me/</code>
注:この記事では、郵便配達員には多くの有用な機能があることを見てきました。無料版をアップグレードした後(ライセンスごとに9.99ドル)、複数のデータ値でAPIコレクションを実行するなど、より多くの機能があります。
結論 APIを作成することは、多くの重要なステップを含む重要なタスクです。郵便配達員は、徹底的なテストプロセスを容易にします。現在、郵便配達員は平均的な開発者の問題をうまく解決しているようです。ただし、Web業界でよく見られるパラダイムシフトでそれがどのように進化するかはまだわかりません。
郵便配達員の重要な特徴がありませんか?別のクライアントを使用してAPIをテストしていますか?以下のコメントでお知らせください。郵便配達員でAPIの構築とテストに関するよくある質問 郵便配達員とは何ですか?また、APIの構築とテストにどのように役立ちますか?
Postmanは無料の有料バージョンを提供しています。 Postman Basicと呼ばれる無料版は、個々の開発者または小チームのニーズを満たすのに十分な強力な機能セットを提供します。 Postmanは、高度な機能とコラボレーションを必要とする大規模なチームまたは企業向けに有料プランを提供しています。
Postman Proは、基本版にはない追加機能を提供する有料版です。これらには、チームコラボレーション、API監視、高度なAPIドキュメントなどが含まれます。複雑なAPI開発プロジェクトを管理する必要があるプロの開発者とチーム向けに設計されています。
公式ウェブサイトから郵便配達員を購入できます。チームの規模と特定のニーズに基づいて、さまざまな価格設定計画を提供します。ニーズに合った計画を選択し、プロンプトに従って購入を完了することができます。
自動テストには郵便配達員を使用できますか?
PostmanでAPIリクエストを整理する方法は?
郵便配達員はさまざまなタイプの認証をサポートしていますか?
ポストマンコレクションを他の人と共有できますか?
郵便配達員を効果的に使用する方法を学ぶ方法は?
以上がAPIの構築とテストにより、郵便配達員は簡単になりましたの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。