backlog Postman Collection について

プロジェクト管理のクラウドサービス backlog のAPIへ手軽にアクセスできるように作成した Postman Collection ファイルです。

API 開発・検証のためのコラボレーションツール Postman にインポートして利用できます。

英語版と日本語版があり、好きな方をインポートして使ってください。

Backlog API Reference を元に作成しています。

使い方

この Github リポジトリからJSONファイルをダウンロードして、Postmanにインポートするだけです。

Collection には予めAPI Keyを使った認証が実施できるようになっているので、backlog のユーザー設定画面から、API Keyを生成し、環境変数を書き換えてください。合わせて接続先のURLも調整してください。

GET系のエンドポイントはデータを取得することができます。「プロジェクト一覧の取得」や「課題一覧の取得」はそのまま実行して試すことができます。

また、Paramsには backlog APIで利用できるすべてのクエリパラメータが登録されています。実行したいクエリを有効化して、任意のパラメータ値を設定すれば簡単にフィルターなどが実施できます。

DescriptionにはAPI Referenceから引用したパラメータの説明文も入っているので、どんな値を設定すればいいかもわかりやすいかなと思います。

データの登録・更新・削除も実施できます。以下はプロジェクトの操作例です。

Bodyタブに予め登録できるパラメータの一覧が表示されているので、必要な値を入力もしくは入力しないパラメータを無効化してリクエストしてみてください。VALUE欄には予めその値の型も指定されていますし、Descriptionで必須項目かどうかも確認できます。

ほとんどの操作は上記手順で実施できますが、例外として「添付ファイルの送信」機能があります。

これはBodyのValue欄からファイルを選択して実行します。

また、プログラムから実行したい場合にもPostmanは便利です。Codeスニペットの機能を使って、各プログラミング言語での簡単な実行コードを入手できます。

以下はVisual Studio から C# で backlog の APIを実行してみたものです。

この Github の Issue もしくは各SNSアカウントまで。