個人プロジェクトでバックエンドとしてSupabaseを使っている。
SupabaseだとUIをぽちぽちするだけでバックエンドが完成。とても便利だ。
フロントエンドに集中した開発ができる。
今回はSupabaseで設定したバックエンド情報を元にTanStack Queryのエンドポイントメソッドを自動生成してみようと思う。しかし、OpenAPIのドキュメントをいちいち書くのがめんどくさいのでSupabaseさんに生成してもらいたい。
OpenAPIドキュメント生成
公式ドキュメントやGoogleドキュメントで調べてみてもやり方が見つからず、、
ChatGPT先生に聞いてみた。
Supabaseは、自動生成されたAPIドキュメントを提供しています。これを取得するには、以下のURLにアクセスします。
https://YOUR_PROJECT_ID.supabase.co/rest/v1/?apikey=YOUR_ANON_KEY
これが出ていると言うことは、きっと公式ドキュメントのどこかに書いてそう。
YOUR_PROJECT_IDとYOUR_ANON_KEYを探しに行く。
メニューからProject Settingsに入る。
GeneralのReference IDがYOUR_PROJECT_IDに該当する。
APIに入るとYOUR_ANON_KEYも確認できる。
結果
ちゃんとしたものが返ってきた！内容見た限り問題なさそう。
しかし、swaggerのバージョンが2.0のため、3.0に変換したい。
変換してくれるサイトがあったので使ってみた。
URLを入れると...
見慣れたSwagger UIの画面が出てきた！(エンドポイントのパラメータが表示されないのが少し気になる)
あとはOrvalで自動生成するだけ。