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
13
OpenAPIについて
OpenAPIとは
何ができるか/何が良いのか
魔迦論
May 03, 2025
Tweet
Share
More Decks by 魔迦論
See All by 魔迦論
GitHub Actionsのハンズオン
mackalong
0
21
英文の読み方
mackalong
0
5
useSWRについて
mackalong
0
8
JWTについて_基本編
mackalong
1
8
Featured
See All Featured
Balancing Empowerment & Direction
lara
1
81
The Psychology of Web Performance [Beyond Tellerrand 2023]
tammyeverts
47
2.8k
Designing for Performance
lara
608
69k
StorybookのUI Testing Handbookを読んだ
zakiyama
30
5.8k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
8
740
Building Applications with DynamoDB
mza
95
6.4k
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
panda_program
105
19k
GraphQLの誤解/rethinking-graphql
sonatard
71
11k
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
Put a Button on it: Removing Barriers to Going Fast.
kastner
60
3.9k
Building Adaptive Systems
keathley
41
2.6k
Optimising Largest Contentful Paint
csswizardry
37
3.3k
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 拡張機能あり