今回の記事はPostmanの導入ガイド第1話になります。
さ、はじめよう。
Postman?
PostmanはAPIを構築・利用するためのAPIプラットフォームです。PostmanはAPIライフサイクルの各ステップを簡素化し、コラボレーションを合理化することで、より良いAPIをより速く作成することができます。
API repository
Postmanを使うことにより、すべてのAPI成果物を1つの中央プラットフォーム上に簡単に保存、カタログ化、コラボレーションできます。Postmanは、APIの仕様書、ドキュメント、ワークフローのレシピ、テストケースとその結果、メトリクスなど、APIに関連するあらゆるものを保存・管理できます。
Tools
Postmanプラットフォームには、設計、テスト、ドキュメンテーション、モッキングからAPIの共有など、APIライフサイクルの加速を支援する包括的なツールセットが含まれています。
Workspaces
Postmanのワークスペースには、個人用、チーム用、パートナー用、パブリック用の4種類があります。
Integrations
Postmanはソフトウェア開発パイプラインの最も重要なツールと統合し、APIファーストの実践を可能にします。Postmanプラットフォームはまた、Postman APIやオープンソーステクノロジーによって拡張可能です。
Download
下記のLink postmanのセットアップFileをDownloadします。
https://www.postman.com/downloads/
Postmanのアカウントを作成します。
こちらはPostman アカウントLoginしたあとの画面です。
自分のアカウントにすでに作成したCollectionsなどが同期されます。
Try the Web Version
PC Version以外にもPostmanのWeb Versionがありますので、今回はWeb版を試してみましょう。
Create Workspace
Workspacesに現在自分のアカウントにあるWorkspacesが表示されます。
Create Workspaceをクリックし、新しいWorkspaceを生成します。
Blank workspaceを選び>Nextで進みます。
Workpsace名を入力します。
Done!新しいWorkspace作成しました。
Prepare API
次はPostmanを実際に使用してみます。今回weatherapiを試しますので、下記のLinkからweatherapiのアカウントを作成します。
こちらはweatherapiのDashboardになります。
Try API
Swagger Toolを使用し、API内容を確認しましょう。
AuthorizeをクリックしAPI認証します。
weatherapiの認証するためにAPI Keyを使用します。
先ほどのweatherapi DashboardのAPI KeyをCopyします。
Done!API Keyの認証ができました。
次はGET リクエストを試します。
GETリクエストに必要なパラメータを入力し、Executeでリクエストを送信しましょう。
Done!Responseは200であり、パリの気温も取得しました。
Test from Postman
最後はPostmanから試します。先ほど追加したWorkspaceに新しいCollectionを作成します。
新しいCollectionが追加され、わかりやすい名前に変更しましょう。
Add a requestをクリックし新規APIリクエストを追加します。
Done!新しいAPIリクエストを追加しました。
APIリクエスト名を変更します。
APIリクエストのURLを入力します。
先程weatherapiで使用したAPI URLを貼り付け、Sendでリクエストを送信します。
Done!weatherapiからデータを受信しました。
