microcms-js-sdk icon indicating copy to clipboard operation
microcms-js-sdk copied to clipboard

Management API 対応

Open albno273 opened this issue 2 years ago • 10 comments

日頃からお世話になっております。

本番環境では公開済みのコンテンツのみを表示したいが、テスト環境では下書き状態のコンテンツも含めて表示し、一覧ページや詳細ページなどサイト全体の表示を確認したいという状況に直面しましたので、パラメータなどで叩く先を Management API に切り替えられるようにしていただけると大変ありがたいです…!

albno273 avatar Sep 26 '22 03:09 albno273

@albno273

Issueを発行してくださりありがとうございます!!! 確かにマネジメントAPIについてもSDKで提供できる方が良さそうですね・・・!

ただ今回の場合ですとAPIキーの「下書きの全取得」で要件満たせるかもです! そちらもご確認頂けると幸いです。

dc7290 avatar Sep 26 '22 04:09 dc7290

@dc7290 返信ありがとうございます。 確かにそれでいけそうです…!試してみます!

albno273 avatar Sep 26 '22 05:09 albno273

@dc7290 こちら実装予定はありますか?

公開予定を設定しているコンテンツに対し処理を行いたいのですが、公開予定を設定しているコンテンツを判別する方法がManagement APIしかないため利用を検討しております。

方針として

  • インターフェースは増やさず、 BASE_DOMAINbaseUrl をリクエスト時に差し替え可能にする
  • Management API用のインターフェースを整備する

の2パターンがありそうですが、ベータなので簡易的に前者で対応し、正式対応までには後者を検討する、という進め方はいかがでしょうか。 レスポンスの形式が微妙に異なるので最終的にはちゃんとインターフェースを整える必要がありそうですが、contentsのmetadata取得系をいったん利用してみる分には前者でコスパよく利用できるように見えました。

hori-ryota avatar May 28 '23 09:05 hori-ryota

baseUrlを差し替える方針で #56 にて実装してみました。

hori-ryota avatar May 28 '23 10:05 hori-ryota

@hori-ryota

コメント、並びにPRの作成ありがとうございます!

結論から言うと、ManagementAPIについて社内でもSDKの方針について定まっていないんですよね・・・ 具体的にはこのSDKに取り込むのか、別ライブラリとして扱うのかなどになります。

つきましてはいったんこのPRについては閉じさせてもらって、通常のfetchを使用してもらう形になりそうです💦

dc7290 avatar May 30 '23 06:05 dc7290

@dc7290 返信ありがとうございます。

承知いたしました。いったんfetchで実装はしたのでそちらを利用してみます。

一方で当リポジトリのNode.jsバージョンが14系(サポート終了済み)だったりでsdkのメンテナンス状況が気になっています。 もしsdk利用を推奨というわけではなさそうでしたら別途作成しようと思いますが、当面の状況はいかがでしょうか。

(と書いていて思ったのですが、Discord入ったほうが良さそうですね、後でお邪魔します!)

hori-ryota avatar May 30 '23 06:05 hori-ryota

おっと! Nodeのバージョンが低い件は単純に見逃しですね💦

ぜひPRとか作ってもらえると大変助かります😭

dc7290 avatar May 30 '23 06:05 dc7290

了解です!↓のmswの件が落ち着くのを待つかもですが、手を付けられたらつけてみます!

https://github.com/mswjs/msw/issues/1388

hori-ryota avatar May 30 '23 06:05 hori-ryota

@dc7290 コンテンツのステータスを取得するため、Management APIを使用したいと考えています。 こちらのIssueでのやりとりからかなりの間が経過していると思うのですが、まだ対応方針が決まっていないのでしょうか?最新情報を共有頂けると幸いです

tecsoc avatar Sep 01 '23 11:09 tecsoc

@tecsoc 返信遅れて申し訳ありません🙇‍♂️ 現在、ちょうど画像アップロードAPIへの対応で、マネジメントAPIへの対応をしております。 コンテンツのステータスの取得についてはまだ未定とはなりますが、一旦ご報告まで!

dc7290 avatar Mar 14 '24 10:03 dc7290