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
OpenAPIについて
Search
魔迦論
May 03, 2025
0
16
OpenAPIについて
OpenAPIとは
何ができるか/何が良いのか
魔迦論
May 03, 2025
Tweet
Share
More Decks by 魔迦論
See All by 魔迦論
GitHub Actionsのハンズオン
mackalong
0
24
英文の読み方
mackalong
0
9
useSWRについて
mackalong
0
8
JWTについて_基本編
mackalong
1
9
Featured
See All Featured
Gamification - CAS2011
davidbonilla
81
5.3k
Site-Speed That Sticks
csswizardry
10
640
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
43
2.4k
Being A Developer After 40
akosma
90
590k
Product Roadmaps are Hard
iamctodd
PRO
53
11k
Build your cross-platform service in a week with App Engine
jlugia
231
18k
Improving Core Web Vitals using Speculation Rules API
sergeychernyshev
16
930
KATA
mclloyd
29
14k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
10
910
Stop Working from a Prison Cell
hatefulcrawdad
269
20k
Embracing the Ebb and Flow
colly
86
4.7k
Optimizing for Happiness
mojombo
379
70k
Transcript
OpenAPI Specification について
OpenAPI Specification とは 概念 API 仕様のフォーマット どこで( エンドポイント) どんなメソッドで(HTTP メソッド)
どんなデータを送るのか( リクエストデータ) どんなデータが返ってくるのか( レスポンスデータ) 実体 API 仕様定義ファイル ⇨YAML または JSON ファイル 具体的な書き方は調べてください( 難しくないです) Swagger Editor などを使うと、リアルタイムプレビューしながら書けるそう ⇨直でyaml を書くのは結構辛い、 、 、
何ができるのか/ 何が良いのか 1. 統一されたAPI 仕様書の作成 ⇨フロントとバックでの認識齟齬が起こりにくい 2. API 定義書を他ツールと連携させることで開発効率UP できること
連携ツール 備考 自動でAPI テストケ ース作成 Postman Github Action などと組み合わせることで、定義書更新⇨テストケース更新の自 動化も可能 モックサーバーの自 動構築 Prism コード生成 Swagger Codegen Swagger Codegen では、SDK( 例 リクエスト/ レスポンスのユーザー定義型) や バック骨組みモックの生成が可能 ドキュメント生成 Redoc, Swagger UI SwaggerUI はVSCode 拡張機能あり