Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
個人開発アプリにスキーマ 駆動開発を取り入れた話
Search
虎の穴ラボ株式会社
November 30, 2023
Programming
0
210
個人開発アプリにスキーマ 駆動開発を取り入れた話
2023年11月30日に行われた「秋の終わりまでにチャレンジしたことLT会」にて発表した内容となります。
虎の穴ラボ株式会社
November 30, 2023
Tweet
Share
More Decks by 虎の穴ラボ株式会社
See All by 虎の穴ラボ株式会社
Tailwind CSSとAtomic Designで実現する効率的な Web 開発の事例
toranoana
1
420
Denoについて、同人誌記事を出しました+update
toranoana
0
120
【虎の穴ラボ Tech Talk #2】プロンプトエンジニアリング
toranoana
0
44
20241121_[TechTalk#2]虎の穴ラボでのLLMについて取り組み紹介
toranoana
0
64
社内チャットへRAG導入した話(Tech Talk #2)
toranoana
0
92
Deno Deploy で Web Cache API を 使えるようになったので試した知見
toranoana
1
400
【虎の穴ラボ Tech Talk】虎の穴ラボTech Talk説明資料
toranoana
0
270
虎の穴ラボ Tech Talk_CDKでFargate環境構築
toranoana
1
300
虎の穴ラボスキルアップ支援制度の利用例
toranoana
0
3.8k
Other Decks in Programming
See All in Programming
5分で理解する SOLID 原則 #phpcon_nagoya
shogogg
1
410
iOSでQRコード生成奮闘記
ktcryomm
2
120
オレを救った Cline を紹介する
codehex
13
13k
Datadog Workflow Automation で圧倒的価値提供
showwin
1
300
クリーンアーキテクチャから見る依存の向きの大切さ
shimabox
5
1.1k
CSS Linter による Baseline サポートの仕組み
ryo_manba
1
160
Swift Testingのモチベを上げたい
stoticdev
2
190
PEPCは何を変えようとしていたのか
ken7253
3
300
AIプログラミング雑キャッチアップ
yuheinakasaka
20
5.1k
CDK開発におけるコーディング規約の運用
yamanashi_ren01
2
260
Honoとフロントエンドの 型安全性について
yodaka
7
1.5k
React 19アップデートのために必要なこと
uhyo
8
1.6k
Featured
See All Featured
Optimizing for Happiness
mojombo
377
70k
BBQ
matthewcrist
87
9.5k
For a Future-Friendly Web
brad_frost
176
9.6k
Build The Right Thing And Hit Your Dates
maggiecrowley
34
2.5k
No one is an island. Learnings from fostering a developers community.
thoeni
21
3.2k
How GitHub (no longer) Works
holman
314
140k
Speed Design
sergeychernyshev
27
820
Java REST API Framework Comparison - PWX 2021
mraible
29
8.4k
Principles of Awesome APIs and How to Build Them.
keavy
126
17k
The World Runs on Bad Software
bkeepers
PRO
67
11k
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
soudai
175
52k
A better future with KSS
kneath
238
17k
Transcript
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. 個人開発アプリにスキーマ 駆動開発を取り入れた話
虎の穴ラボ株式会社 浜田拓実 (sheltie) 2022 秋の終わりまでにチャレンジしたことLT会 11/30
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. 自己紹介 浜田
拓実(ハマダ タクミ) • 2022/06 入社 • 虎の穴ラボ 通販コスト削減チーム エンジニア Goを使い始めた理由 • シンプルな構文でコードがガリガリ書ける(気がする) • エイリアスや省略した書き方が少ない(気がする) 今季の推しアニメ • SHY • 16bitセンセーション
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. ・スキーマ駆動開発とは ・スキーマ駆動開発を取り入れた理由
・実際にやってみる ・OpenAPIでAPI仕様書を作成 ・ツールを利用してGo言語のファイルを出力 ・プログラムの修正 ・まとめ アジェンダ
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. スキーマ駆動開発とは 2022
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. スキーマ駆動開発とは スキーマ駆動開発(Schema-Driven
Development)は、ソフトウェア開発のアプ ローチの一つです。通常、データの構造や形式が事前に定義されたスキーマ に基づいています。これにより、開発者はデータの構造や型を明示的に定義 し、それに基づいてコードを構築します。 By ChatGPT 先にAPIのパラメータやDBのテーブル構造を決めておき、その設 計に沿ってプログラムを作成する開発手法のこと
Copyright (C) 2021 Toranoana Inc. All Rights Reserved. スキーマ駆動開発を 取り入れた理由
6 2022
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. スキーマ駆動開発を取り入れた理由 ・設計と実装を一元管理したい
個人開発のため、思いついたらそのまま実装(設計書は書かない) ➡自分でどんなAPIを作ったのか思い出せない ➡APIのパラメータを忘れた ➡APIのメソッドも忘れた(POSTだっけ? PUTだっけ?) 設計書は必要だ!
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. スキーマ駆動開発を取り入れた理由 ・設計書の管理はどうするか?
スプレッドシート ➡設計と実装がずれる自信がある! GoDocに書く ➡出力されるフォーマットがAPI向きではない
Copyright (C) 2021 Toranoana Inc. All Rights Reserved. 実際にやってみる 9
2022
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. OpenAPIでAPI仕様書を作成 ・エディタを整備
VSCodeに以下2つの拡張機能を導入
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. OpenAPIでAPI仕様書を作成 ・エディタを整備
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. ツールを利用してGo言語のファイルを出力 ・作成したOpenAPI仕様書からGoのプログラムを出力
今回は「oapi-codegen」を利用します ➡変換後のファイルが1つなので、管理が楽そう ➡main関数はすでに作成済みなので、 ジェネレーターから出力されなくて良い
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. ツールを利用してGo言語のファイルを出力 ・oapi-codegenの利用方法
導入 go install github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@latest 変換 oapi-codegen -package petstore petstore-expanded.yaml > petstore.gen.go
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. ツールを利用してGo言語のファイルを出力 ・oapi-codegenの利用方法(自分の場合)
oapi-codegen -package generated -generate types,server,spec ./openapi.yaml > ./openapi.go 以下のコードのみ出力 ・APIパラメータの構造体 ・サーバーサイドのAPI定義の利用(Echoのルーター定義など)
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. ツールを利用してGo言語のファイルを出力
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. プログラムの修正 ・生成されたコードに合わせて既存のプログラムを修正
➡独自に定義していた構造体を削除 この修正に合わせて、構造体利用箇所も修正 ➡生成されたハンドラーの実装(次で紹介) ➡Echoのルーティングを削除 生成されたコードのルーティングを利用するように修正(次で紹介)
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. プログラムの修正 ハンドラーの実装
ハンドラーの登録
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. 動作確認
Copyright (C) 2021 Toranoana Inc. All Rights Reserved. まとめ 19
2022
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. まとめ ・スキーマ駆動開発を取り入れて
➡APIの設計と実装が一元管理できるようになった! ➡APIの設計書が出来た! ・注意事項 APIを修正するときはyamlファイル修正、 その後ジェネレータでソース出力する 出力されたファイルを修正しないように注意!!!
Copyright (C) 2020 Toranoana Inc. All Rights Reserved. ご静聴ありがとうございました 2022