CiNiiのAPIを使用して特定のキーワードを用いて最新論文を取得するコマンドの作成

[ktaroabobon]

As Is

• Discordボットには現在、学術論文を検索して提供する機能が存在しない。

To Be

• DiscordボットがCiNiiのAPIを用いて特定のキーワードで検索した最新の学術論文の情報を取得し、/thesis コマンドを通じてユーザーに提供できる。
• Clean Architectureに従った適切なファイルと関数分けを行い実装されている

アクション

• [ ] CiNii APIの使用方法を調査し、必要なリクエストパラメータとレスポンスデータの形式を理解する。
• [ ] CiNii APIのAPP_IDを環境変数として設定する機能を実装する。
• [ ] /thesis コマンドを解析し、キーワードに基づいてCiNii APIを呼び出す機能を開発する。
• [ ] APIから得られた論文情報をDiscord上で適切にフォーマットして表示する機能を実装する。

課題

• CiNii APIを利用するにはAPI_APP_IDが必要であり、これを安全に管理する方法を確立する必要がある。
• CiNii APIのレートリミットや使用条件を確認し、ボットの実装においてこれらの制約に対応する設計を行う必要がある。

[ktaroabobon]

CiNii APIの使用に関連する課題とその対処法

API_APP_IDの安全な管理

CiNii APIの利用には、API_APP_IDが必要です。このIDを安全に管理するため、以下の対処法を採用します。

対処法:

• envファイルの使用: API_APP_IDを .env ファイルに保存し、このファイルを .gitignore に追加してGitリポジトリには含めないようにします。
• 環境変数の読み込み: アプリケーションの初期化時に .env ファイルから環境変数を読み込み、APIリクエストに使用します。

CiNii APIの利用規約とその遵守

CiNii APIを使用する際、利用者はAPIの利用規約に同意し、遵守する必要があります。重要な規約は以下の通りです。

重要な規約:

• 利用目的: APIは学術研究や非営利の情報利活用のためにのみ使用可能です。商用利用は事前の承認が必要です。
• APIキーの管理: APIキーは第三者に貸与、譲渡しないこと。盗難や不正使用が判明した場合は直ちに報告すること。
• データの更新: CiNiiのデータベースは週一回、毎週月曜日の早朝に更新されます。現状ではキャッシュを利用するなどの方法は取りませんが、将来的にはこの点を考慮する可能性があります。

これらの規約を遵守することで、CiNii APIを効果的かつ責任を持って使用することができます。APIの利用にあたっては、これらの規約に留意し、適切な管理と遵守を心がけてください。