• Home
• コーポレートブログ
• RedmineのREST APIを活用してプロジェクトメンバーやロール、公開設定などのレポートを作成しています

今週のブログ担当の石川です。これが2023年最初のブログになりますね。本年もどうぞよろしくお願いいたします。

さて、Redmineにはさまざまな便利機能がありますが、管理者としてプロジェクトやユーザーの情報をチェックするためにCSVを出力する機能もあります。

• 各ロールがどんな権限を持っているかが分かる権限レポートCSV (管理 > ロールと権限 > 権限レポート > CSV)
• ユーザー一覧CSV (管理 > ユーザー > CSV)
• プロジェクト一覧CSV(プロジェクト一覧 > 表示形式をリストに変更 > CSV)

など。
（参考）RedmineでCSVエクスポートできるデータ

CSV出力で得られる結果や画面に表示されている情報をうまく組み合わせることでも十分な情報を得ることができますが、ファーエンドテクノロジーでは自分たちが必要な情報を扱いやすい形式にまとめられるようにRedmine REST APIから情報を取得して出力するスクリプトを利用しています。

自作スクリプトで出力するMarkdownファイルの内容(プレビュー)

自作スクリプトでは、「プロジェクトに対してユーザーが過剰な権限を持っていないか」「プロジェクトが公開状態になっていないか」などをはじめとしたチェックしたい情報をまとめてMarkdown形式のファイルを作成します。

出力するためのスクリプト

使っているAPI

• Projects API
  https://redmine.org/projects/redmine/wiki/Rest_Projects
• Project Memberships API
  https://redmine.org/projects/redmine/wiki/Rest_Memberships
• Users API
  https://redmine.org/projects/redmine/wiki/Rest_Users
• Groups API
  https://redmine.org/projects/redmine/wiki/Rest_Groups

さらに活用

出力される情報はテキストファイルなので、diffコマンドを使って二つのファイルを比較することで差分を出力することができます。 例えばプロジェクトメンバーを追加した前後でレポートを作成していた場合、その2つのファイルをdiffコマンドで diff -u output_redmine_permissions_2023-01-10.md output_redmine_permissions_2023-01-11.md のように比較すると次のような差分になります。

--- output_redmine_permissions_2023-01-10.md  2023-01-10 15:42:14
+++ output_redmine_permissions_2023-01-11.md    2023-01-11 09:07:33
@@ -32,6 +32,7 @@
 |[John Smith](http://localhost:3000/users/2)|Manager|
 |[Dave Lopper](http://localhost:3000/users/3)|Developer|
 |[Dave2 Lopper2(locked)](http://localhost:3000/users/5)|Developer|
+|[Redmine Admin](http://localhost:3000/users/1)|Manager|

 ## 5. [Private child of eCookbook](http://localhost:3000/projects/5)

定期的にこのレポートの出力と比較を行うことで、管理しているRedmineに対して「プロジェクトに対してユーザーが過剰な権限を持っていないか」「プロジェクトが公開状態になっていないか」などのチェックを行うことができます。

まとめ

Redmine REST APIをうまく使うことで、このように自分たちが必要な情報を扱いやすい形式にまとめて出力することもできます。ぜひ活用してみてください。

【スタッフ募集中】
弊社ではAWSを活用したソリューションの企画・設計・構築・運用や、Ruby on Rails・JavaScriptフレームワークなどを使用したアプリケーション開発を行うスタッフを募集しています。採用情報の詳細
弊社での勤務に関心をお持ちの方は、知り合いの弊社社員・関係者を通じてご連絡ください。

---