APIドキュメント

Swaggerは、APIドキュメントの生成、視覚化、保守のためのさまざまなソリューションにより、APIドキュメントの手作業を削減します。

SwaggerHubでAPIを文書化

オープンソースUIをお探しですか?Swagger UIをダウンロードする

API設計からのドキュメント作成

APIの機能は進化しますが、APIドキュメントの保守による頭痛の種は避けられます。Swaggerツールは、APIドキュメントの生成と保守における困難を解消し、APIの進化に合わせてドキュメントを最新の状態に保ちます。

APIの可視化のためのSwaggerHubポータル

APIドキュメントのホスティングのためのSwaggerHub

APIを視覚化するためのSwagger UI

Documentation From Your API Design
既存APIの文書化

ドキュメントはAPI定義から自動生成できます。しかし、既存のAPIに定義がない場合はどうでしょうか?既存の(Java)APIコードからOpenAPI定義を生成するオープンソースのSwagger Coreを提供しています。このプロセスを高速化するために、チームはSwagger Inspectorを使用して、任意のエンドポイントのOpenAPIファイルを自動生成することもできます。

既存の(Java)APIコードからOpenAPIを生成するためのSwagger Core

OpenAPI定義を自動生成するためのSwagger Inspector

Documenting Existing APIs

複数のドキュメントバージョンの保守

APIの内部および外部の利用者は、APIの利用方法に関する必要な情報とともに、利用可能なすべてのAPIバージョンを簡単に検出できる必要があります。SwaggerHubのバージョニングシステムを使用して、既存のAPIドキュメントを段階的に構築するか、複数のAPIバージョンのドキュメントを保守します。

バージョニングドキュメントのためのSwaggerHubを探索する

Maintain Multiple Documentation Versions

ツール

カスタマイズ可能なAPI開発者ポータル

SwaggerHubの最新機能であるSwaggerHubポータルを使用すると、包括的なコンシューマー向けドキュメントを作成し、APIの検出可能性の向上とオンボーディングの高速化を実現できます。