コレクション＆フィールド設計

前提

• 名称の定義
  • 入力されたデータは コンテンツ（content）
  • コンテンツを入れる箱を コレクション（collection）

スキーマ

directusを参考にしています

superfast_collections

カラム名	タイプ	長さ	NULL許可	キー	デフォルト	コメント
collection	varchar	64		primary		テーブル名
singleton	boolean	1			false	true：単票モデル、false：リストモデル
hidden	boolean	1				関連テーブルなど画面に表示しない場合
created_at	dateTime
updated_at	dateTime

superfast_fields

カラム名	タイプ	長さ	NULL許可	キー	デフォルト	コメント
id	int	11		primary
collection	varchar	64		primary	テーブル名
field	varchar	64				フィールド名 (例: name)
label	varchar	64				フィールドの表示名 (例: 名前)
special	varchar	64	Yes			one 2 manyとかの関連を入れてる
interface	varchar	64	Yes			input, input-multiline, input-rich-text-md ... etc
readonly	boolean	1				修正不可（idとか）
required	boolean	1				値入力が必須かどうか
hidden	boolean	1				表示しない
options	json		Yes			最小/最大桁数制限とか、画面で使うオプションをkey-valueで入れる
sort	integer	8	Yes			カラムの表示順
created_at	dateTime
updated_at	dateTime

superfast_relations

カラム名	タイプ	長さ	NULL許可	キー	デフォルト	コメント
id	int	11		primary
many_collection	varchar	64
many_field	varchar	64
one_collection	varchar	64
one_field	varchar	64	Yes
one_collection_field	varchar	64	Yes
one_allowed_collections	text		Yes
junction_field	varchar	64	Yes
sort_field	varchar	64	Yes
one_deselect_action	varchar	255	Yes
created_at	dateTime
updated_at	dateTime

directusからまんまもってきた。関連性を表すメタ情報

API IF

コレクション一覧取得

/collections

例）http://localhost:8080/collections

collections: [
  {
    collection: 'Restaurant'
    singleton: false,
    fields: [
      {
          collection: Restaurant,
          field: 'name',
          interface: 'input',
          ...
      },
      {
          collection: Restaurant,
          field: 'nick name
          interface: 'input',
          ...          
      },
    ]
  },
  {
    collection: 'Company'
    singleton: true,
    fields: [
      {
          collection: Company,
          field: 'name',
          interface: 'input',
          ...
      },
      {
          collection: Company,
          field: 'company name
          interface: 'input',
          ...          
      },
    ]
  }
]

コレクションの登録

POST /collections

リクエストボディ

{
  collection: "Restaurant",
  singleton: false,
  hidden: false
}

レスポンス（204でも良いかも？）

collection: {
    collection: 'Restaurant'
    singleton: false
}

挿入されるデータ

superfast_collections

id	collection	singleton	hidden
1	Restaurant	false	false

superfast_fields（一部省略）

id	collection	field	label	interface
1	Restaurant	id	Id	input

新規作成されるテーブル

Restaurant

カラム名	タイプ	長さ	NULL許可	キー	デフォルト	コメント
id	int	11		primary
status	varchar	20			draft	'draft' or 'published'
published_at	dateTime
created_at	dateTime
updated_at	dateTime

コレクションの編集

PUT /collections/:collection

例）http://localhost:8080/collections/Restaurant

リクエストボディ

collection, singletonは変更不可

{
  hidden: false,
}

レスポンス（204でも良いかも？）

collection: {
    collection: 'Restaurant'
    singleton: false,
    hidden: false
}

コレクションの削除

DELETE /collections/:collection

例）http://localhost:8080/collections/Restaurant

以下を削除

• superfast_collections
• superfast_fields
• Restaurantテーブル

フィールドの追加

POST /fields/:collection

例）http://localhost:8080/fields/Restaurant

リクエストボディ

{
  field: has_parking,
  label: '駐車場有無',
  interface: 'select-dropdown',
  readonly: false,
  required: true,
  hidden: false
}

レスポンス（204でも良いかも？）

field: {
  collection: Restaurant,
  field: has_parking,
  label: '駐車場有無',
  interface: 'select-dropdown',
  readonly: false,
  required: true,
  hidden: false
}

追加後のテーブル

Restaurant

カラム名	タイプ	長さ	NULL許可	キー	デフォルト	コメント
id	int	11		primary
has_parking	varhcar	255
created_at	dateTime
updated_at	dateTime

フィールドの削除

DELETE /fields/:id

例）http://localhost:8080/fieldes/1

以下を削除

• superfast_fieldsの該当行
• Restaurantテーブルの該当カラム