低コストでAPI管理をオールインワンで実現｜Apidog導入事例

• API仕様の自動生成:
  • コードから生成したOpenAPI形式のJSON SchemaからAPIドキュメントを自動生成でき、インターネットに公開できるサービスが必要だった。
• 課金体系:
  • 開発エンジニアは数名規模であったため、高額なエンタープライズプランや最低利用人数が多いサービスは選択肢に上がりませんでした。利用人数に応じた低コストなユーザー数課金で提供されるサービスが絶対条件でした。
• APIテスト:
  • APIのユニットテストはCIで担保していましたが、複数のAPIを呼び出すシナリオ（結合）テストは、手動や個人のPostman実行に依存していました。製品品質の向上のためには、この属人化した結合テストを自動化・仕組化する必要がありました。

• Stoplight
• SwaggerHub
• Redocly

• APIドキュメントをJSON Schemaで更新できるか
• 導入する際のランニングコストが安価か
• APIテストがGithub Actionsから実行できるか

導入検討時の3つの課題（ホスティング、コスト、結合テスト）を、Apidogがオールインワンで、かつ最も高い費用対効果で解決できる点が決め手となりました。

• 圧倒的なコストパフォーマンス:

  • 比較した他サービスと比べて価格が大幅に安価であり、少人数のスタートアップが求める「低コストなユーザー数課金」の条件を完璧に満たしていたこと。当時同じ事をするのにStoplightは129$/moかかるのに対してApidogでは12$/moで実現ができた。

• ドキュメント生成とホスティングの容易さ:

  • コードから生成したOpenAPI (JSON Schema) ファイルをインポートするだけで、即座に高機能な開発者ポータル（API仕様書）を自動生成・公開できる手軽さ。

• CI/CD連携とテスト自動化:

  • APIテスト（シナリオ）を実行するためのGitHub Actions連携機能が標準で提供されていること。これにより、ドキュメント管理とテスト品質の向上を、追加開発なしで同時に実現できると判断しました。

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

当初解決したかった問題は全て解決されました。

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

• ドキュメントの陳腐化がほぼ解決: Apidogをコードから生成されるAPIドキュメントと定める運用ルールを徹底した結果、設計の変更がドキュメントに即座に反映されるようになりました。これにより、仕様の乖離や確認コストはゼロに近くなりました。

• 開発プロセスの属人化が改善: GUIベースでAPI定義やテストシナリオが管理されるようになり、特定の担当者しか仕様を把握していない、テストを実行できない、という状況が解消されました。チーム全体でAPIの品質を担保する意識と体制が整いました。

• 品質の担保: ドキュメントとテストが常に連動しているため、APIの品質とドキュメントの正確性が担保されるようになりました。これにより、QAチームのテスト工数も削減できました。

• 基本的にはしっかりとしたヘルプが用意されているため困ることがありませんでした。
• こちらのようにカスタムドメインを設定してAPIドキュメントを公開することができますが、ヘルプはAWSでの設定方法になっていたため、Google Cloudを利用した場合の設定に少し苦労をしました。

弊社での導入時点でのAPIドキュメントを公開できるサービスとしては、世にあるツールの中でも最もコストパフォーマンスに優れたサービスだと思います。またある程度経験のあるバックエンドエンジニアであればApidogの利用方法にもすぐ慣れるかと思います。

現状ではAPIの改修リリース後に手動でAPIドキュメントの更新をしているため、これをGithub Actionsと連動させて完全に自動化させるようにCI/CDを構築していく予定です。