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
9
JWTについて_基本編
mackalong
1
12
Featured
See All Featured
Designing Dashboards & Data Visualisations in Web Apps
destraynor
231
53k
Fashionably flexible responsive web design (full day workshop)
malarkey
407
66k
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
sstephenson
161
15k
Imperfection Machines: The Place of Print at Facebook
scottboms
267
13k
StorybookのUI Testing Handbookを読んだ
zakiyama
30
5.9k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
21
1.4k
The Psychology of Web Performance [Beyond Tellerrand 2023]
tammyeverts
48
2.9k
jQuery: Nuts, Bolts and Bling
dougneiner
63
7.8k
How STYLIGHT went responsive
nonsquared
100
5.7k
Measuring & Analyzing Core Web Vitals
bluesmoon
7
530
Art, The Web, and Tiny UX
lynnandtonic
301
21k
Code Review Best Practice
trishagee
69
19k
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 拡張機能あり