API開発プロセスの効率化：Apidogによる課題解決と導入効果

ツール導入前の課題

• API仕様書
  • ドキュメント共有ツールを使って独自フォーマットで記載していたため、詳細な情報の記載が不十分で、担当者間で認識を合わせるのに時間がかかっていました
• API実装・テスト
  • API仕様書と実装で差異が多く発生していました
    cURLを利用した手動テストを実施していたため、パラメータ名やデータ型などの確認粒度が担当者によってばらつきがあったのと、データ量が増えると確認に時間がかかり、結果として漏れにつながっていました
• APIモック
  • API先行で開発していく計画だっため、当初APIモックを導入していませんでした
    しかし計画通りに進まず、API開発待ちや簡易的なモックを急遽実装することになり余計な工数が発生しました
  • フロントエンドの動作確認に実装済みのAPIを使用していたため、確認に必要なAPIレスポンスのバリエーションを用意するのに時間がかかっていました

OpenAPI(Swagger) + モックツール

• 導入前の課題を解消できるか
• 導入する際のコスト（学習コストや構築にかかるコスト）

導入前の課題を解消できるのはもちろん、API仕様書、APIのテスト、モック機能が同一プラットフォーム内で完結しており、学習コストや構築にかかるコストも低いと判断した点になります。

改善したかった課題はどれくらい解決されたか

導入前の全ての課題を解決することができました。

どのような成果が得られたか

• API仕様書
  • ApidogのUI上で詳細な情報（データの閾値など）を入力できるようになり、仕様書の品質が向上し、必要な情報を一元的に確認できるようになりました
    結果として、担当者間の認識合わせにかかる時間も減ったと思います
• APIの実装・テスト
  • Apidogには作成したAPI仕様書を基にAPIをテストする機能があり、この機能を使うことで仕様書と実装の差異を確認できるようになり、差異を減らすことができています
    開発途中で仕様変更が発生した場合に、実装だけ修正してAPI仕様書の修正が漏れるようなケースも防ぐことができていると思います
• APIモック
  • API仕様書を基にAPIモックを簡単かつ短時間で作成できるようになりました
  • ApidogのUI上で返却値を指定できるため、フロントエンドエンジニアが必要なレスポンスのバリエーションを設定できるようになり、フロントエンドの開発とテストがより円滑に進むようになりました

• ツール自体が使いやすくヘルプもあったため、記載している機能については実際に操作しながら学習することで、スムーズに導入できました
• コード生成機能など、まだ活用できていない機能もあるため、今後はApidogのさらなる活用を模索していく予定です

Freeプランでもほとんどの機能が利用可能なため、まずはFreeプランでの試用をお勧めします。
直感的なGUIを採用しているため、基本機能は容易に試すことができます。