予算管理ページのapi定義 #900

Kubosaka · 2024-12-26T11:49:32Z

対応Issue

resolve #901

概要

予算管理ページで必要なAPIをopenapiで定義した
/financial_records
- 支出元　局など
/divisions
- 部門
/festival_items
- 物品

画面スクリーンショット等

URL

テスト項目

apiの定義が正しいか確認する

備考

apiは実装していないです。

figma
ER図

hikahana · 2024-12-26T16:44:31Z

swaggerで見たいからgenerateまでしてもいいかも

リンクだけじゃなくて該当箇所のスクショもあったら凄く嬉しいです！！
私も次からそうします！

hikahana

簡単にコードレビューしました！

hikahana · 2024-12-26T16:38:20Z

openapi/openapi.yaml

+          application/json:
+            schema:
+              $ref: "#/components/schemas/division"
+        required: false


Suggested change

required: false

required: true

更新だしtrueでも良さそう

他も同様

hikahana · 2024-12-26T16:46:47Z

openapi/openapi.yaml

@@ -767,6 +831,134 @@ paths:
        "200":
          description: yearで指定されたexpensesを取得
          content: {}
+  /festival_items:


PRはfinacial_itemsと書かれてましたがfestival_itemsが正しい方ですよね.。
正直どっちでもいいとは思いますけど。

hikahana · 2024-12-26T16:48:55Z

openapi/openapi.yaml

+      responses:
+        "200":
+          description: 作成されたdivisionが返ってくる
+          content: {}


Suggested change

content: {}

content:

application/json:

schema:

$ref: "#/components/schemas/division"

type: objectでもよいかも？

仮初めだけどcontentは書きたいマン

他も同様

idも含めて返したいと思い、getで配列で返しているオブジェクトを返すようにしました
response修正

hikahana · 2024-12-26T17:06:21Z

openapi/openapi.yaml

+    festivalItem:
+      required:
+        - name
+        - divisionId
+        - amount
+      type: object
+      properties:
+        name:
+          type: string
+          example: 農ポリ
+        divisionId:
+          type: integer
+          example: 1
+        amount:
+          type: integer
+          example: 10000
+        memo:
+          type: string
+          example: ""


festtival_itemとitem_budgetが統合されてる感じがしますけどがpostとputの際どうする予定とかあります？
普通にテーブル統合してpostするだけ？

パラメータ受け取って適宜バックエンドでトランザクション貼って複数のテーブルにインサートするイメージです

なら良さそう！

hikahana · 2024-12-26T17:14:20Z

openapi/openapi.yaml

@@ -1927,6 +2255,18 @@ components:
        remark:
          type: string
          example: ""
+    total:


このレビューに関係ないので読み飛ばし可です。

これ別個でAPI生やして管理します？それとも各APIに組み込ますか？
totalの使い方まだピンと来てないマンです。

api内で集計して、totalに整形して返すイメージです。
局、部門、物品で合計が必要になるので、レスポンスで返す共通の型を定義した感じです。
apiを生やす？ってのがピンときていないです

totalって何回も算出されそうだからtotal用のAPI作ってもいいのかなって思ってだったんですけど、よく考えたらべつにAPI作る必要なさそうですね

hikahana · 2024-12-26T17:22:25Z

あと私のgo.mod以下みたいになったんですけどなります？
websocketが消えた

module github.com/NUTFes/FinanSu/api

go 1.16

require (
	github.com/go-sql-driver/mysql v1.6.0
	github.com/go-test/deep v1.0.8 // indirect
	github.com/google/go-cmp v0.6.0 // indirect
	github.com/joho/godotenv v1.4.0
	github.com/labstack/echo/v4 v4.11.4
	github.com/oapi-codegen/runtime v1.1.1
	github.com/pkg/errors v0.9.1
	github.com/slack-go/slack v0.13.0
	github.com/stretchr/testify v1.9.0 // indirect
	golang.org/x/crypto v0.23.0
	golang.org/x/net v0.25.0 // indirect
	gorm.io/driver/mysql v1.3.3
	gorm.io/gorm v1.23.4
)

Kubosaka · 2024-12-27T01:40:43Z

自分も消えました
使ってないようなので消した方でコミットしました
#900 (comment)

hikahana

Kubosaka added 4 commits December 26, 2024 17:12

支出元api定義

848d80a

部門のapi追加

08e1a7c

購入物品のopenapi定義

3621d13

レスポンス修正

9f46fa0

Kubosaka requested review from KazumaSun, hikahana and TkymHrt December 26, 2024 11:49

Kubosaka changed the title ~~予算管理ページのapi~~ 予算管理ページのapi定義 Dec 26, 2024

Kubosaka self-assigned this Dec 26, 2024

Kubosaka added the backend label Dec 26, 2024

Kubosaka requested a review from Chikuwa0141 December 26, 2024 13:43

hikahana reviewed Dec 26, 2024

View reviewed changes

Base automatically changed from feat/kubosaka/fix-openapi to develop December 27, 2024 01:14

Kubosaka added 4 commits December 27, 2024 10:20

Merge branch 'develop' into feat/kubosaka/create-budgets-openapi

f125911

gomod修正

71bb85a

yml修正

2c6ae91

response修正

050555e

hikahana approved these changes Dec 27, 2024

View reviewed changes

Kubosaka merged commit 997ccae into develop Dec 30, 2024
1 check passed

Kubosaka deleted the feat/kubosaka/create-budgets-openapi branch December 30, 2024 05:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

予算管理ページのapi定義 #900

予算管理ページのapi定義 #900

Kubosaka commented Dec 26, 2024 •

edited

Loading

hikahana commented Dec 26, 2024

hikahana left a comment

hikahana Dec 26, 2024

hikahana Dec 26, 2024

Kubosaka Dec 27, 2024

hikahana Dec 26, 2024

hikahana Dec 26, 2024

hikahana Dec 26, 2024

Kubosaka Dec 27, 2024

hikahana Dec 26, 2024

Kubosaka Dec 27, 2024

hikahana Dec 27, 2024

hikahana Dec 26, 2024

Kubosaka Dec 27, 2024

hikahana Dec 27, 2024

hikahana commented Dec 26, 2024 •

edited

Loading

Kubosaka commented Dec 27, 2024

hikahana left a comment

予算管理ページのapi定義 #900

予算管理ページのapi定義 #900

Conversation

Kubosaka commented Dec 26, 2024 • edited Loading

対応Issue

概要

画面スクリーンショット等

テスト項目

備考

hikahana commented Dec 26, 2024

hikahana left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hikahana commented Dec 26, 2024 • edited Loading

Kubosaka commented Dec 27, 2024

hikahana left a comment

Choose a reason for hiding this comment

Kubosaka commented Dec 26, 2024 •

edited

Loading

hikahana commented Dec 26, 2024 •

edited

Loading