JSON Schema で Firestore データベースをドキュメント化
Interactive schema viewer for Firebase & Firestore · Like Swagger for NoSQL
Firestore コレクションを美しいインタラクティブなドキュメントに変換。JSON Schema 標準を使用。バックエンド不要、設定不要、即座に動作。
この 2 行を任意の HTML ページに追加
<link rel="stylesheet" href="unpkg.com/firestore-schema-viewer/dist/style.css">
<script src="unpkg.com/firestore-schema-viewer/dist/fsv.umd.js"></script>FireSchema の特徴
自動検出
.schema.json ファイルのフォルダを指定すると、FireSchema がコレクションツリー全体を自動的に構築します。
バックエンド不要
純粋な静的 SPA です。GitHub Pages、Vercel、または任意の CDN でホストできます。サーバー、データベース、API は不要です。
フォルダ = 階層
フォルダ構造が Firestore パスを反映します。ネストされたフォルダは自動的にサブコレクションになります。
AI対応
付属のプロンプトテンプレートを使用して、任意の LLM でスキーマファイルを生成できます。コレクションを説明するだけで、有効なスキーマが得られます。
CDN または npm
単一のスクリプトタグで CDN 経由で使用するか、npm からインストールしてビルドパイプラインで完全に制御できます。
すべての開発者のために設計
一人で開発している場合でもチームを管理している場合でも、FireSchema はあなたのワークフローに適応します
個人開発者向け
MVP やサイドプロジェクトを構築中?複雑なツールのオーバーヘッドなしで、最初から Firestore データベースを整理して保つことができます。
- CDN 経由で 5 分以内にセットアップ
- 無料、オープンソース、バックエンド不要
- コレクションがスパゲッティになる前にドキュメント化
チームとテックリード向け
誰もデータベースをドキュメント化しないと、新しい開発者のオンボーディングに数週間かかります。FireSchema は、リポジトリを生きたデータモデルリファレンスに変えます。
- 数週間ではなく数時間で開発者をオンボード
- Schema の変更は PR によるコードレビューを経る
- Git リポジトリ内の単一の情報源
実際に動作確認する
サンプル Firestore コレクションを備えたライブ FireSchema ビューアを探索してください。コレクションをクリックしてスキーマを参照できます。
セットアップを選択
プロジェクトに合った方法を選んでください。CDN が最も手軽です。
<!-- index.html -->
<link rel="stylesheet"
href="https://unpkg.com/firestore-schema-viewer/dist/style.css">
<div id="app"></div>
<script src="https://unpkg.com/firestore-schema-viewer/dist/fsv.umd.js"></script>
<script>
FirestoreSchemaViewer.render('#app', {
schemasDir: './schemas/'
})
</script>- インストール不要
- HTML ファイル1つ
- 常に最新版
- インターネット必要
- バージョン固定不可
0 KB — CDN から読み込み