(質問)自作APIのファイルはどこに配置したらいいか
2025年2月19日 15時01分 [akaz]こんにちは!
こちらのサイトを拝見して SamplesPlugin を作ってみました。そして、外部のサービスからデータを取得する自作APIも作成してみました。
これに関連して、以下について質問させていただきます。ご指導いただけますでしょうか。
【質問】自作APIのファイルはどこに配置したらいいか。
SamplesPlugin のコントローラは、app/PluginsOption/User/ の中に配置しました。自作のコントローラは、このディレクトリ内に配置するのがルールのようです。(スクリーンショットの青枠)
これに対し、自作API(myApi)はどのディレクトリに配置するとよいのでしょうか。以下のいずれかだと思いますが、とりあえず(1)に配置したところ、SamplesPlugin.php から、myApi.php をコールできて、外部サービスからデータも取得できました。
(1) app/PluginsOption/Api/ (スクリーンショット赤枠)
(2) app/PluginsOption/User/
(3) app/PluginsOption/Api/User/
(デフォルトでは Userディレクトリが無いので自分で作る)
(4) app/Plugins/Api/User/
(デフォルトで Userディレクトリが有る。スクリーンショットオレンジ枠)
不適切なディレクトリに配置すると、Connect-CMSのアップデートがあったときなどに、自作APIが上書きされたり、削除されたり、機能しなくなったりすることを恐れています。最適な配置ディレクトリを教えていただけますと大変ありがたいです!
よろしくお願いいたします。