Feat/backend/api/v1

[KinjiKawaguchi]

やったこと

• 動作するAPIを作った

やらないこと

• APIが正しいレスポンスコードを返すようにする
• エラーメッセージの整備

[h-takeyeah]

Go詳しくないのでメモがてらテーブルを貼っておきます、すみません

Score:
	+------------+-----------+--------+----------+----------+---------+---------------+-----------+-----------------------------+------------+---------+
	|   Field    |   Type    | Unique | Optional | Nillable | Default | UpdateDefault | Immutable |          StructTag          | Validators | Comment |
	+------------+-----------+--------+----------+----------+---------+---------------+-----------+-----------------------------+------------+---------+
	| id         | uuid.UUID | true   | false    | false    | true    | false         | false     | json:"id,omitempty"         |          0 |         |
	| keystrokes | int       | false  | false    | false    | false   | false         | false     | json:"keystrokes,omitempty" |          0 |         |
	| accuracy   | float64   | false  | false    | false    | false   | false         | false     | json:"accuracy,omitempty"   |          0 |         |
	| created_at | time.Time | false  | false    | false    | true    | false         | true      | json:"created_at,omitempty" |          0 |         |
	+------------+-----------+--------+----------+----------+---------+---------------+-----------+-----------------------------+------------+---------+
	+------+------+---------+---------+----------+--------+----------+---------+
	| Edge | Type | Inverse | BackRef | Relation | Unique | Optional | Comment |
	+------+------+---------+---------+----------+--------+----------+---------+
	| user | User | true    | scores  | M2O      | true   | false    |         |
	+------+------+---------+---------+----------+--------+----------+---------+
	
User:
	+----------------+-----------+--------+----------+----------+---------+---------------+-----------+---------------------------------+------------+---------+
	|     Field      |   Type    | Unique | Optional | Nillable | Default | UpdateDefault | Immutable |            StructTag            | Validators | Comment |
	+----------------+-----------+--------+----------+----------+---------+---------------+-----------+---------------------------------+------------+---------+
	| id             | uuid.UUID | true   | false    | false    | true    | false         | false     | json:"id,omitempty"             |          0 |         |
	| student_number | string    | true   | false    | false    | false   | false         | false     | json:"student_number,omitempty" |          1 |         |
	| handle_name    | string    | false  | false    | false    | false   | false         | false     | json:"handle_name,omitempty"    |          2 |         |
	| created_at     | time.Time | false  | false    | false    | true    | false         | true      | json:"created_at,omitempty"     |          0 |         |
	| updated_at     | time.Time | false  | false    | false    | true    | true          | false     | json:"updated_at,omitempty"     |          0 |         |
	+----------------+-----------+--------+----------+----------+---------+---------------+-----------+---------------------------------+------------+---------+
	+--------+-------+---------+---------+----------+--------+----------+---------+
	|  Edge  | Type  | Inverse | BackRef | Relation | Unique | Optional | Comment |
	+--------+-------+---------+---------+----------+--------+----------+---------+
	| scores | Score | false   |         | O2M      | false  | true     |         |
	+--------+-------+---------+---------+----------+--------+----------+---------+
	

https://entgo.io/docs/code-gen/#schema-description を参考に以下のコマンドで生成しました。

# typing-server/ ディレクトリで
go run -mod=mod entgo.io/ent/cmd/ent describe ./domain/repository/ent/schema 

[h-takeyeah]

PRのテンプレートを作ったのならあえて破壊する理由がない限り、沿った方がよいと思う

[h-takeyeah]

OpenAPIからドキュメントを作るとこんな感じになります。これも併用しつつレビューします

https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/su-its/typing/feat/backend/api/v1/typing-server/openapi.yaml

[h-takeyeah]

おつかれさまです

[h-takeyeah]

正確性という言葉だけでなく計算方法も示してあげる方が親切かと。例えば正確性 (ミスタイプ数 / キーストローク数)、など。これ書くならむしろ計算方法だけの方がいいかもですけどその辺は読みやすいように書いてください。

(杞憂だと思いますがfloatの丸め誤差がないと思うけど少し気になる&ミスタイプ数があればGo側で計算できるから、accuracyの代わりにミスタイプ数を送れば整数で送れて_HAPPY_かもしれません)

[h-takeyeah]

OpenAPIを見ました

[h-takeyeah]

こちらも作成された Score を返すべきだと思います！根拠は RFC7231 です (これは MDN) https://developer.mozilla.org/ja/docs/Web/HTTP/Status/201

[h-takeyeah]

おまけでそのスコアだとおよそ何位になるかという情報も一緒に返してあげると嬉しいかもね(RESTとは)(これは今後の課題というか半分冗談なので対応しなくてよいです！) 👍

[h-takeyeah]

よ～しスピード優先でマージしちゃうぞ～(合意済み)