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
80
個人開発アプリにスキーマ 駆動開発を取り入れた話
2023年11月30日に行われた「秋の終わりまでにチャレンジしたことLT会」にて発表した内容となります。
虎の穴ラボ株式会社
November 30, 2023
Tweet
Share
More Decks by 虎の穴ラボ株式会社
See All by 虎の穴ラボ株式会社
FreshとHonoでDeno KVを使い倒す
toranoana
1
45
サブカル業界Developers_実践_開発業務でのAIの活用
toranoana
1
280
「エンジニアリングマネージャーのしごと」勉強してみた
toranoana
2
260
【OSC2024 Online/Spring】とらのあなラボの Deno イベント開催の取り組み
toranoana
0
290
【toranoana.deno#15】WebGPUで遊ぼう
toranoana
0
320
App Router による Web 開発について
toranoana
0
95
Fresh(Deno)をプラグインで拡張しよう!
toranoana
0
220
Freshプラグインのテストもプラグインを使うと捗る!
toranoana
0
120
Exceptionハンドリングの基本と新しい手法について【JJUG CCC 2023 fall】
toranoana
3
510
Other Decks in Programming
See All in Programming
Build Apps for iOS, Android & Desktop in 100% Kotlin With Compose Multiplatform (mDevCamp 2024)
zsmb
0
360
MicrosoftのPlatform Engineeringガイドを読んで実際になにかやってみた
ymd65536
1
420
OpenAPIを中心に考えるAPI開発入門 / Introduction to API Development with a Focus on OpenAPI
seike460
PRO
2
170
Random\Randomizer クラスで日常のあれこれを解決しよう! / Random\Randomizer class solves familiar trouble
cocoeyes02
0
250
Code Reviews
bkuhlmann
4
890
使ってみよう Azure AI Document Intelligence
kosmosebi
2
330
Zero Waste, Radical Magic, and Italian Graft – Quarkus Efficiency Secrets
hollycummins
0
230
Fragment Composition of GraphQL
quramy
7
1k
"config" ってなんだ? / What is "config"?
okashoi
0
240
Apache Hive 4 on Treasure Data
ryukobayashi
0
360
if constexpr文はテンプレート世界のラムダ式である
faithandbrave
3
650
雑に思考を整理する技術と効能
konifar
60
29k
Featured
See All Featured
Fontdeck: Realign not Redesign
paulrobertlloyd
76
4.9k
Raft: Consensus for Rubyists
vanstee
132
6.3k
Visualization
eitanlees
136
14k
XXLCSS - How to scale CSS and keep your sanity
sugarenia
241
1.2M
Making Projects Easy
brettharned
108
5.5k
How To Stay Up To Date on Web Technology
chriscoyier
782
250k
The Straight Up "How To Draw Better" Workshop
denniskardys
227
130k
StorybookのUI Testing Handbookを読んだ
zakiyama
13
4.6k
The MySQL Ecosystem @ GitHub 2015
samlambert
243
12k
Testing 201, or: Great Expectations
jmmastey
28
6.4k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
21
1.6k
Creating an realtime collaboration tool: Agile Flush - .NET Oxford
marcduiker
14
1.5k
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