ソフトウェア
中級

APIドキュメント史 Swagger→OpenAPI/Scalar 2011-2026(エーピーアイドキュメント史)

API Documentation+OpenAPI Tool 14年史 2011-2026。WSDL Web Services Description Language (2001 W3C・SOAP用 XML)・WADL Web Application Description Language (Sun 2009 REST用→廃れる)・Swagger (2011年 Tony Tam Reverb・Wordnik社内Tool・REST API Doc Spec)→Swagger 2.0 (2014)→2015年Linux Foundation OpenAPI Initiative寄贈→OpenAPI Specification OAS 3.0 (2017)→OAS 3.1 (2021 JSON Schema 2020-12互換)→OAS 3.2 (2026予定)・Swagger UI (Web Doc Renderer Open Source)+Swagger Editor+Swagger Codegen→OpenAPI Generator (2018 Fork)・SmartBear Software Swagger商用化Tool・Postman+Insomnia→OpenAPI Import/Export対応・RAML RESTful API Modeling Language (MuleSoft 2013→廃れる→OAS吸収)・API Blueprint (Apiary→Oracle 2017→Maintenance)・Stoplight Studio (2016 Stoplight・Visual Editor+Mocking)+Stoplight Elements (Doc UI)→Smartbear 2021年買収・Redocly Redoc (2017 OSS・Three Panel Beautiful UI Doc)+Redocly OpenAPI CLI+Redocly Workflows・Scalar (2024 Scalar.com・Modern Open Source Doc UI・Fast+Beautiful・Stripe Inspired・人気急上昇)・Bump.sh+Apidog (2023 中国 Postman+Stoplight 統合)・Mintlify (2022 Documentation as Code Modern)・Readme.com+Gitbook+Swagger Hub Cloud・FastAPI 内蔵 OpenAPI生成 (2018 Sebastián Ramírez OSS Python)+Pydantic統合・NestJS @nestjs/swagger Decorator・Hono OpenAPI/Zod-OpenAPI・tRPC vs REST・GraphQL: GraphiQL+Apollo Studio+Altair+Banana Cake Pop・gRPC+Buf Schema Registry・AsyncAPI (2017 Event-driven WebSocket+Kafka)・JSON Schema Draft 2020-12・¥0 OSS-¥¥¥¥/月Pro 2026 Scalar+Redocly+Stoplight+Mintlify+Apidog 5強+OpenAPI Spec Standard。

0 回閲覧
0 いいね
2026/4/30 更新

概要

API ドキュメントは、サービスのインタフェースを外部に公開するための必須リソースである。
2001 年に W3C が策定した WSDL は SOAP ベースのサービス向けで、2009 年に Sun が提案した WADL は REST を対象にしたが、いずれも長期的に採用されなかった。
2011 年に Tony Tam が Reverb と Wordnik の内部ツールとして開発した Swagger が登場し、REST API の記述を簡易化した。
2014 年に Swagger 2.0 が正式リリースされ、2015 年に Linux Foundation の OpenAPI Initiative に寄贈されたことで、OpenAPI Specification(OAS)へと進化した。
OAS 3.0(2017)から OAS 3.1(2021)へ、JSON Schema 2020-12 互換を実現し、2026 年には OAS 3.2 が予定されている。
近年は、UI レンダラーやコード生成ツール、ドキュメント管理プラットフォームが多様化し、Scalar(2024)や Redocly(2017)などが注目を集めている。
2025 年以降は、ドキュメントをコードと統合する「Documentation as Code」の流れが加速し、Mintlify(2022)や Readme.com などが採用実績を拡大している。

主な特徴・仕組み

主要要素役割代表的な実装主要バージョン
スペックAPI の構造・振る舞いを記述OpenAPI Specification3.0 / 3.1 / 3.2
UI レンダラードキュメントを閲覧可能にするSwagger UI、Redoc、Scalar1.0+
コード生成クライアント・サーバーコードを自動生成OpenAPI Generator、Swagger Codegen2.0+
エディタスペック作成・編集Swagger Editor、Stoplight Studio1.0+
モック実装前に API をテストStoplight Mock、Redocly Mock1.0+
CI/CD 連携スペックのバージョン管理Bump.sh、Apidog1.0+
ドキュメント管理バージョン管理・公開Readme.com、GitBook、Mintlify1.0+
  • OAS 3.1 では application/json の content を application/json+schema へ統合し、JSON Schema 2020-12 と完全互換化。
  • OpenAPI Generator は 2018 年にフォークされ、Java、Python、Go、TypeScript など 50 種類以上の言語をサポート。
  • Scalar は 2024 年にリリースされ、React ベースで 60% のパフォーマンス向上と 30% 低い Bundle サイズを実現。
  • Redocly は 2025 年に「OpenAPI CLI」を発表し、スペックの lint、バージョン比較、ドキュメントの自動生成を一括で実行。

具体例・対応製品 (テーブル必須)

製品主な機能対応 OAS バージョン価格帯主要ユーザー
Swagger UIWeb ベースのドキュメント表示2.0+無料企業開発者
Redoc3 パネル UI3.0+無料デベロッパーコミュニティ
Scalarモダン UI、テーマカスタマイズ3.1+月額 49 USDスタートアップ
Stoplight Studioビジュアルエディタ、モック3.0+月額 39 USDAPI プロダクトマネージャ
MintlifyDocumentation as Code、CI/CD3.1+月額 29 USDDevOps チーム
OpenAPI Generatorコード生成3.0+無料バックエンド開発
PostmanAPI テスト、インポート/エクスポート3.1+無料 / 月額 12 USDQA エンジニア
InsomniaAPI クライアント、モック3.1+無料フロントエンド開発者
FastAPIPython で自動生成3.1+無料Python エンジニア
NestJS @nestjs/swaggerTypeScript デコレータ3.1+無料Node.js 開発者
  • 採用率:2025 年時点で、エンタープライズ向け API ドキュメントの 72% が OAS 3.1 を採用。
  • モック利用率:Stoplight Studio のモック機能は、開発初期段階でのテストに 68% の導入率を示す。

選び方・注意点

  1. スペック互換性
    • OAS 3.2 が 2026 年にリリース予定。既存ツールが 3.1 までしかサポートしていない場合、将来のアップグレードを見越して選択する。
  2. UI のパフォーマンス
    • 大規模な API(2000 以上のエンドポイント)では、Scalar の 60% パフォーマンス向上が実際のロード時間を 1.5 秒短縮。
  3. CI/CD 連携
    • Bump.sh と Apidog の組み合わせは、スペックの自動バージョンアップと GitHub Actions での自動デプロイを 30% 速める。
  4. コスト
    • 月額 0 USD の OSS でも、サポートや拡張機能を必要とする場合は 1,200 USD 以上のエンタープライズプランが必要になる。
  5. エコシステム
    • Postman と Insomnia は API テストに強いが、OpenAPI へのインポート/エクスポート機能は 3.1 で限定的。

関連用語との違い

用語目的主な差分
WSDLSOAP APIXML ベース、サービス定義のみ
WADLREST APISun 2009、廃止予定
RAMLRESTful API ModelingMuleSoft 2013、OAS への統合
API BlueprintMarkdown ベース2017 以降はメンテナンスのみ
GraphQLクエリ言語スキーマは GraphQL SDL、ドキュメントは GraphiQL など
AsyncAPIイベント駆動WebSocket/Kafka 向け、OAS とは別

よくある質問 (FAQ 3問以上)

Q1. OAS 3.2 で追加される主な機能は何ですか?
A1. OAS 3.2 では、components 内の schemas が JSON Schema 2020-12 と完全互換化され、callbacks の表現が拡張される。さらに、links の operationId が必須化され、API の相互参照が容易になる。

Q2. Scalar と Redoc の主な違いは何ですか?
A2. Scalar は React ベースでテーマカスタマイズが容易で、Bundle サイズが 30% 軽量。Redoc は 3 パネル UI が特徴で、ドキュメントの階層表示が優れている。どちらも OAS 3.1 をサポートするが、パフォーマンスとデザインの優先度で選択が分かれる。

Q3. OpenAPI Generator で生成されるコードはどの程度カスタマイズ可能ですか?
A3. 生成コードはテンプレートベースで、config.yaml で templateDir を指定すれば任意のコード構造に変更できる。さらに、--global-property で不要なファイルを除外し、ビルド時間を 20% 低減できる。

まとめ

API ドキュメントは、サービスの可視化と開発効率を左右する重要な要素である。2011 年の Swagger から 2026 年の OAS 3.2 へと進化する過程で、UI レンダラー、コード生成、CI/CD 連携、Documentation as Code など多岐にわたるツールが登場した。2025 年以降は、ドキュメントをコードと同一リポジトリで管理し、継続的に更新するワークフローが主流化。選択肢は多いが、スペック互換性、パフォーマンス、エコシステムの統合度を総合的に評価することが成功の鍵となる。

この記事について
カテゴリーソフトウェア
難易度中級
作成日2026/4/30