DEV Community

Cover image for 最高の養蜂場代替案
Akira
Akira

Posted on • Originally published at apidog.com

最高の養蜂場代替案

Apiaryは閉鎖されます。OracleはApiaryサポート終了の発表を行っており、APIツール業界全体の報道によると、ホスト型サービスは2026年9月頃にシャットダウンされる見込みです。サイトは現在もアクセスできますが、その方向性は数年前から明らかでした。Oracleは2017年1月にApiaryを買収し、2018年には有料プランを非推奨とし、関連するオープンソースツールであるDreddとGavelはアーカイブ状態へ移行しました。apiary.ioでAPIドキュメントを管理しているなら、代替案を検討する段階は終わっています。エクスポートと移行を開始してください。

今すぐApidogを試す

結論から言うと、ApidogはApiaryの有力な代替ツールです。Apiaryで利用していたデザインファーストの仕様編集、ホスト型インタラクティブドキュメント、モックサーバーを置き換えつつ、自動APIテスト、アーカイブ済みのDreddに代わる仕様駆動の検証、CI連携も提供します。

注意点は1つです。ApidogはAPI Blueprintを直接インポートできないため、BlueprintベースのプロジェクトはOpenAPIへ変換する必要があります。本記事では、移行時に必要な作業、変換時の確認項目、代替ツールを選ぶべきケースを実装手順として整理します。

Apiaryに実際に何が起きているのか

2011年に設立されたApiaryは、デザインファーストのAPIワークフローを製品として広めました。OpenAPIが主流になる前から、MarkdownベースのAPI記述形式であるAPI Blueprint、3カラムのドキュメントレイアウト、ホスト型モックサーバー、GitHub同期を提供していました。DreddとGavelも、仕様と実装の整合性を確認するためのツールとして利用されていました。

Oracleによる2017年の買収後、製品開発は停滞しました。2018年には有料ティアが非推奨となり、DreddとGavelもアーカイブされました。現在はサポート終了が発表され、ホスト型サービスは2026年9月頃に停止する見込みです。

移行ガイドを公開しているベンダーの一つであるBump.shも、Apiaryへの惜別の投稿で、シャットダウン前にAPI記述をエクスポートする必要性を指摘しています。

実務上の対応は次の2点です。

  1. Apiaryにしか存在しないデータを今すぐ退避する

    API記述、ドキュメント本文、チーム設定、モックURLの利用先を確認します。

  2. API BlueprintからOpenAPIへ移行する

    API Blueprintには保守された後継エコシステムがほぼないため、移行先のプラットフォームにかかわらずOpenAPIを標準フォーマットにするのが現実的です。

Apiaryで使っていた機能を棚卸しする

移行先を選ぶ前に、チームがApiaryのどの機能に依存しているか確認してください。

  • デザインファーストの仕様エディター

    ブラウザ上でAPI Blueprint、または後期プロジェクトではOpenAPI 3.0を編集し、ドキュメントを即時更新していました。

  • ホスト型インタラクティブドキュメント

    apiary.ioのURLで、リクエスト例とAPIリファレンスを公開していました。

  • モックサーバー

    仕様内の例を返すモックエンドポイントにより、バックエンド完成前から利用者が統合できました。

  • GitHub同期

    仕様ファイルをリポジトリと同期していました。

  • Dreddによる契約テスト

    実装へリクエストを送信し、仕様との差異を確認していました。Dreddは現在アーカイブ済みです。DreddなしでAPIをその仕様に対して検証する方法も確認してください。

移行先は、単なるドキュメントレンダラーではなく、仕様、ドキュメント、モック、検証を同じOpenAPI定義から扱えるプラットフォームとして選ぶと作業を減らせます。

Apidogで置き換えられること

Apidogは、設計、ドキュメント、モック、デバッグ、自動テストを単一の仕様に基づいて扱うAPI開発プラットフォームです。

ApidogのAPI開発プラットフォーム画面

Apiaryから移行する場合、主に次の機能を利用できます。

  1. OpenAPIを中心にしたデザインファースト開発

    ApidogはOpenAPI 3.x向けのビジュアル仕様エディターとコードエディターを提供します。エンドポイント、スキーマ、レスポンス例を定義すると、ドキュメント、モック、テストをその定義から生成できます。

  2. ホスト型かつインタラクティブなドキュメント

    公開ドキュメントには「試す」コンソールを含められます。カスタムドメインとバージョン管理も利用できるため、ApiaryのURLに依存せずにドキュメントURLを管理できます。

  3. 仕様ベースのスマートモック

    Apiaryでは記述した例をモックで返していました。Apidogでは仕様のスキーマからレスポンスを生成でき、必要に応じてカスタムモックルールも追加できます。

  4. Dreddの代替となる仕様検証とCI実行

    自動テストシナリオで実装に実際のリクエストを送信し、レスポンスを仕様のスキーマに対して検証できます。アサーション、データ駆動型ケース、Apidog CLIを使ったCI実行も可能です。MCPサーバーについてはApidog MCP Serverとはを参照してください。

ApiaryからApidogへ移行する手順

BlueprintプロジェクトではOpenAPI変換が必要です。ただし、この作業は一度だけです。まずエクスポートを完了し、その後に変換とインポートを進めてください。

1. Apiaryからすべてをエクスポートする

プロジェクトごとに、ApiaryエディターからAPI記述をダウンロードします。

GitHub同期を利用している場合は、次を確認してください。

  • リポジトリに最新の仕様ファイルがあるか
  • Apiary上の編集内容がリポジトリへ反映済みか
  • API Blueprint以外の補足Markdownや運用メモが別管理されていないか
  • 現在利用中のモックURL、公開ドキュメントURL、連携先を一覧化したか

後期のApiaryプロジェクトでOpenAPI 3.0を使っている場合、変換は不要です。そのままインポートできます。

先にエクスポートを完了してください。移行先の比較やドキュメント再設計は、その後でも実施できます。

2. API BlueprintをOpenAPIへ変換する

API Blueprintのプロジェクトでは、OpenAPIへの変換が必要です。利用できるツールの例は次のとおりです。

  • api-spec-converter：API BlueprintからOpenAPIへ変換するツール
  • apib2swagger：BlueprintからSwagger/OpenAPIへの変換に特化したツール
  • openapi-format：変換後のOpenAPIを正規化し、必要に応じてOpenAPI 3.1へ調整するツール

変換後は、OpenAPIリンターで検証してください。vacuumのようなバリデーター、または既存のOpenAPIツールチェーンを使えます。

特に次の項目は手動で確認します。

確認項目 理由
認証スキーム API Blueprintでは認証が正式にモデル化されていないため、変換結果に漏れや差異が出ることがあります。
リクエスト・レスポンス例 Blueprint内のMarkdown記述とAPI定義が分離している場合、例が十分に復元されないことがあります。
Markdownの説明文 エンドポイント定義ではなく、任意のMarkdownセクションに書かれていた説明は移植されない場合があります。
ステータスコードとスキーマ 変換後のレスポンス定義が実装と一致しているか確認します。

変換はフォーマット移行です。API単位で長期間かける前に、代表的な1本を変換・検証し、差分パターンを把握してから残りへ展開してください。

3. OpenAPIファイルをApidogにインポートする

Apidogのインポートドキュメントによると、ApidogはOpenAPI（Swagger 2.0、OpenAPI 3.0、OpenAPI 3.1）、Postmanコレクション、HAR、RAML、JMeter、apiDoc、I/O Docs、WADL、Google Discoveryをインポートできます。

インポート手順は次のとおりです。

  1. Apidogで対象プロジェクトを作成します。
  2. プロジェクト設定から「手動インポート」を選択します。
  3. 変換済みのOpenAPIファイルを選ぶか、OpenAPIファイルのURLを指定します。
  4. インポート後にエンドポイント、タグ、スキーマ、認証設定、レスポンス例を確認します。
  5. 自動生成されたドキュメントとモックエンドポイントを確認します。

インポート後は、まず利用頻度の高いエンドポイントを数本選び、以下を確認すると効率的です。

  • ドキュメントに正しいパラメータとレスポンス例が表示されるか
  • モックレスポンスが利用者の期待する構造になっているか
  • 認証ヘッダーやセキュリティスキームが正しく定義されているか
  • 既存実装へのリクエストでスキーマ検証が通るか

4. Apiaryでは不足していた検証を再構築する

移行後は、単にドキュメントを公開するだけでなく、仕様を運用の基準として使います。

実施する作業は次のとおりです。

  1. 公開ドキュメントにカスタムドメインを設定する

    ホスティング先が変わっても、利用者向けURLを自社ドメインで維持しやすくなります。

  2. Dreddのチェックをテストシナリオとして再作成する

    代表的な正常系・異常系リクエストを用意し、ステータスコード、レスポンスヘッダー、スキーマを検証します。

  3. CIで仕様検証を実行する

    Apidog CLIを使い、ローカルとCIで同じテストを実行します。

  4. モックURL変更を利用者へ通知する

    ApiaryのモックURLを利用しているチームや外部利用者に、新しいモックベースURLと切り替え期限を共有します。

単一のAPIプロジェクトなら、変換と確認を含めても午後のうちに移行できるケースがあります。複数のBlueprint APIがある場合でも、認証設定と説明文の確認を標準チェックリスト化すれば、作業を繰り返せます。

ApiaryとApidogの比較

項目 Apiary（現在） Apidog
将来 閉鎖予定。サポート終了、サービス終了は2026年9月頃を予定 活発に開発中
仕様フォーマット API Blueprint、その後OpenAPI 3.0 OpenAPI 3.x、Swagger 2.0インポート、ビジュアル・コードエディター
ホスト型ドキュメント あり、apiary.io URL あり、カスタムドメイン、バージョン管理、試用コンソール
モックサーバー 記述された例を再生 スキーマを認識するスマートモック、カスタムルールも可能
契約テスト Dredd（アーカイブ済み） 組み込みテストシナリオ、スキーマ検証、CLIによるCI実行
自動テストスイート なし あり、ビジュアルシナリオ、データ駆動型、無制限実行
GitHub同期 あり URLまたはファイルからの仕様インポート・同期、ブランチベースのバージョン管理
価格 無料。有料プランは2018年に非推奨 4ユーザーまで無料、その後は月額9ドル/ユーザー
エクスポート API Blueprint / OpenAPIダウンロード OpenAPI、Markdown、HTMLエクスポート

無料ツールを置き換えるコスト

Apiaryは無料で使えることが大きな利点でした。移行先を比較する場合は、単なる仕様の表示ではなく、モック、テスト、共同作業まで含めた年間コストで比較してください。

定価ベースでは、Apidogは4ユーザーまで無料で、5ユーザー目以降は月額9ドル/ユーザーです。SwaggerHub Teamは月額34.44ドル/ユーザー、ReadMe Proは年間請求で月額250ドルです。

チームサイズ Apidog 年間費用 SwaggerHub Team 年間費用 ReadMe Pro 年間費用
3人 $0（無料プラン） $1,240 $3,000
5人 $540 $2,066 $3,000
10人 $1,080 $4,133 $3,000
25人 $2,700 $10,332 $3,000

仕様を無料でレンダリングするだけなら、ドキュメント専用ツールの無料ティアも選択肢です。ただし、Apiaryで価値があったモックサーバー、テスト、コラボレーションまで置き換えるなら、機能全体で比較する必要があります。

Apidogが合わない場合

Apiaryを使い続ける選択肢はないため、要件ごとに代替案を判断してください。

  • ドキュメントのレンダリングだけが必要な場合

    仕様の作成・テストを別ツールで完結しており、ホスト型ドキュメントと変更履歴だけが必要なら、Bump.shのようなドキュメントファーストの製品が候補です。この場合もAPI BlueprintはOpenAPIへ変換する必要があります。

  • SmartBearスタックに標準化している場合

    SwaggerHubは、ホスト型仕様レジストリとしてApiaryに近い選択肢です。シート単位の料金と従量課金制のテスト実行を確認してください。最高のSwaggerHub代替品も参考になります。

  • 大規模チームでデザインガバナンスを重視する場合

    Stoplightはスタイルガイドやガバナンス機能を重視するケースに向いています。導入前に最高のStoplight代替品との比較を確認してください。

  • API Blueprintを維持したい場合

    推奨しません。関連ツールは保守されておらず、Apiaryも終了します。OpenAPIへ一度変換し、今後の仕様管理を標準化する方が安全です。API Blueprintのガイドは歴史的な参照として利用できます。

よくある質問

Apiaryはいつ完全にシャットダウンしますか？

OracleはフォーラムでApiaryサポートの終了を発表しています。APIツールベンダーの現在の報告では、ホスト型サービスは2026年9月頃にシャットダウンされる見込みです。正確な日付を待つのではなく、今すぐエクスポートしてください。

ApidogはAPI Blueprintファイルを直接インポートできますか？

できません。ApidogはOpenAPI/Swagger、Postman、HAR、RAML、JMeter、apiDoc、I/O Docs、WADL、Google Discoveryをインポートできます。最初にapi-spec-converterやapib2swaggerでAPI BlueprintをOpenAPIに変換し、変換結果をインポートしてください。

Apiaryのモックサーバーの代替は何ですか？

Apidogに組み込まれたスマートモックサーバーです。Apiaryが記述済みの例を再生していたのに対し、Apidogはスキーマからレスポンスを生成できます。特定のユースケースにはカスタムモックルールを定義できます。

契約テストのためのDreddの代替は何ですか？

Apidogの自動テストシナリオを使えます。実装へ実際のリクエストを送り、レスポンスを仕様のスキーマに対して検証します。アサーションとCLI経由のCI実行も利用できます。

Apidogは小規模チームにとって本当に無料ですか？

はい。無料プランは、仕様エディター、公開インタラクティブドキュメント、スマートモックサーバー、APIテストを含め、最大4ユーザーまで利用できます。4ユーザーを超える場合は月額9ドル/ユーザーです。

まずエクスポートし、再設計は後で行う

移行の順序が重要です。

  1. Apiaryからすべてをエクスポートする
  2. API BlueprintをOpenAPIへ変換する
  3. OpenAPIをインポートして移行先を評価する
  4. ドキュメント、モック、テスト、CIを段階的に切り替える

最初の2ステップには期限があります。ドキュメント構成の見直しやプラットフォーム比較は、仕様を手元へ退避してから進められます。

準備ができたら、OpenAPIファイルをApidogにインポートしてください。ドキュメント、モック、テストハーネスを同じ仕様から再構築できます。Apidogをダウンロードするか、ブラウザから開始してください。

Top comments (0)