初めてのAPI開発のアーキテクチャ

https://metaps.connpass.com/event/307900/

Transcript

1. はじめてのAPI開発
 アーキテクチャ設計
 三海 純(ミカイジュン)

2. 自己紹介
 • 三海純(ミカイ ジュン) • 現在フリーランスエンジニア ◦ Next.jsの新規開発・設計 + Laravel ◦ Python API新規開発・設計 • 趣味 ◦ アニメ(BanG Dream!・ぼざろ 等) ◦ ネット麻雀(雀魂・雀豪)
3. キャリア
 • 2020/06 - 2022/02: 正社員(受託企業) ◦ Vue.js/Nuxt.jsをメイン • 2022/03 - 2023/09: 正社員(自社開発) ◦ バックエンドはPython / Nest.js(Node.js) ◦ フロントエンドはReact.jsとNext.js • 2023/10 - : フリーランス(自社開発) ◦ Next.jsの設計とバックエンド実装を担当 ◦ Python APIの新規開発・設計
4. アーキテクチャ設計
 っていうとどんな
 イメージですか？

6. はっきり言いますね

8. こんな自分が
 API開発の
 0→1を行うことに
 

9. 無闇に開発するのも
 あれなので
 それっぽく設計した
 

10. ・バックエンドはAPIのみ開発。俗にいうマ イクロサービスというやつです
 
 ・リリースしたら終わり！という訳ではない (はず)
 
 前提条件

11. っdd
 補足: APIとは（get）
 データ欲しいです データです
12. っdd
 補足: APIとは（post・put）
 保存したいです 保存成功しました
13. 今回採用したのが

14. 3層アーキテクチャ
 引用元:https://qiita.com/os1ma/items/7a229585ebdd8b7d86c2
15. 3層アーキテクチャとは？
 • プレゼンテーション層
 ◦ ユーザーインターフェースを担当します。ユーザーからの入力を受 け取り、処理結果を表示します。
 • ビジネスロジック層
 ◦ ビジネスロジックを担当します。データの処理や計算を行い、プレゼ ンテーション層とデータアクセス層の間の橋渡し役を務めます。
 • データアクセス層
 ◦ データベースへのアクセスを担当します。アプリケーション層からの 要求を受け、データベースからデータを取得したり、データを更新し たりします。

16. 専 門 用 語 時 間
17. っdd
 簡単にしてみました
 窓口 (プレゼンテーション層) 収納Box (データアクセス層) 加工職人 (ビジネスロジック層) 使用ユーザー 〇〇のデータください 〇〇のデータです データ送受信
18. ディレクトリ構成はこうなる
 root ├── controller(窓口) ├── services(加工職人) └── repositories(収納Box)
19. っdd
 赤枠部分が3層アーキテクチャ
 窓口 (プレゼンテーション層) 収納Box (データアクセス層) 加工職人 (ビジネスロジック層) 使用ユーザー 〇〇のデータください 〇〇のデータです データ送受信
20. っdd
 窓口の役割
 窓口 (プレゼンテーション層) 収納Box (データアクセス層) 加工職人 (ビジネスロジック層) 使用ユーザー 〇〇のデータください 〇〇のデータです データ送受信
21. 窓口(プレゼンテーション層)
 • ユーザーからの入力を受け取り、処理結果を表示する
 
 • 収納Box(データアクセス層)に以下のような命令をする
 ◦ データください
 ◦ データを更新してください
 ◦ データを削除してください
 
 • 逆にいうとそれ以外のロジックはここでは行わない

22. っdd
 収納Boxの役割
 窓口 (プレゼンテーション層) 収納Box (データアクセス層) 加工職人 (ビジネスロジック層) 使用ユーザー 〇〇のデータください 〇〇のデータです データ送受信
23. 収納Box(データアクセス層)
 • データベース(DB)から取得したり、保存したりする
 ◦ MySQL
 ◦ Firebase など
 
 • 逆にいうとデータの加工やエラーハンドリングなどは行わな い
 
 • 理論上、DB移行を行う時はこの層しか触らない
 ◦ Firebase→MySQL移行など

24. っdd
 加工職人の役割
 窓口 (プレゼンテーション層) 収納Box (データアクセス層) 加工職人 (ビジネスロジック層) 使用ユーザー 〇〇のデータください 〇〇のデータです データ送受信
25. 加工職人(ビジネスロジック層)
 • 以下のこと「以外」は全て担当
 ◦ 窓口(プレゼンテーション層)
 ◦ 収納Box(データアクセス層)
 
 • 例えばデータの加工やエラーハンドリングなど
 
 • ロジックは全部加工職人に任せるので記述量がデカくなり がち

26. 設計の参考に
 なれば幸いです

27. ご清聴ありがとうござ います！