“printed sticky notes glued on board” by Daria Nepriakhina on Unsplash

OpenAPI x Design First なアプローチでの API 開発フロー

この記事は今読んでも前提知識がない人にとってはよく分からないかもしれません。それでも公開するのはこの段階からこれを読んで理解できる人からフィードバックが貰えればと思っているからです。

ゴール

• それぞれのブランチで仕様を満たせているかテストができる
• リリースブランチでは今動いている API のドキュメントが見れる
• トピックブランチでは新しい API のドキュメントが見れる

前提条件

• OpenAPI で定義した仕様をもとにテストができるようになっている

開発の流れ

1. 仕様を作成
2. トピックブランチを作成
3. Pull Request を作成
4. API 仕様を編集
5. テストが失敗したことを確認
6. 実装
7. テストが成功したことを確認
8. Pull Request を作成
9. マージ

改善したいこと

”改善したいこと” は改善できたら打ち消してその方法に関して記事を書いてステップにそのリンクを貼ります：

• [3. API 仕様を編集] の時点で編集された API ドキュメントをどこかにホストして API のすり合わせをしやすくする。

関連記事

• Apivore で OpenAPI で定義した仕様と実装の乖離を防ぐ