説明
Zudokuは、オープンソースで拡張性の高いプラットフォームにより、開発者が優れたAPIドキュメントを作成できるようにします。開発者ファーストのアプローチで設計されており、クリーンで一貫性があり、魅力的なAPIリファレンス資料および開発者ポータルの作成を効率化します。このツールは、OpenAPI v2/v3スキーマを包括的なドキュメントに変換するプロセスを簡素化し、単一および複数APIカタログの両方をサポートします。
続きを読む
Zudokuの開始は、迅速かつ直感的に行えるように設計されています。ユーザーは、`npm create zudoku @latest`を使用してコマンドラインから新しいプロジェクトを開始し、その後`npm run zudoku install`でインストールできます。コア機能は、OpenAPIスキーマをプロジェクト構成に統合することです。Zudokuはその後、APIドキュメントを自動生成し、ユーザーがアクセスしやすく理解しやすいものにします。
自動生成を超えて、Zudokuは堅牢なカスタマイズオプションを提供します。開発者は、柔軟なテーマとMDXサポートを使用してドキュメントの外観と感触を調整でき、SEOとパフォーマンスを向上させるためにマークダウンファイルの統合を可能にします。この柔軟性により、ドキュメントがブランドアイデンティティと特定のプロジェクトニーズに一致することが保証されます。
主な機能には、APIキーと認証を完全にサポートする、APIエンドポイントをライブでテストするためのインタラクティブプレイグラウンドが含まれます。Zudokuは、PagefindやInkeepなどのテクノロジーを活用した組み込み検索機能も提供し、情報の即時かつインテリジェントな発見を可能にします。さらに、静的サイト生成をサポートしており、どこにでもホストできる高速でSEOフレンドリーなドキュメントページをデプロイできます。
Zudokuは、さまざまなシナリオでドキュメントをスケーリングおよび強化するように構築されています。その拡張性は、スーパーチャージされたプラグインによってさらに強化され、既存のツールとの簡単な統合とカスタム機能の作成を可能にします。このプラットフォームは、開発ワークフローを加速するために内部APIを文書化するのに理想的であり、公開されている開発者ポータルにも適しています。Zudokuはコミュニティの育成にコミットしており、開発者間の貢献と協力を奨励しています。
- カテゴリーAI コーディングアシスタント
- 料金モデルオープンソース
- デプロイ静的サイト生成
- プラットフォームCLI
Zudokuの主要機能
OpenAPI v2/v3スキーマからAPIドキュメントを自動生成
ライブエンドポイントテスト用のインタラクティブAPIプレイグラウンド
組み込み認証および認可サポート (OAuth2, JWT)
即時でインテリジェントな検索機能
SEOフレンドリーなページのための静的サイト生成
テーマとMDXサポートによる柔軟なカスタマイズ
コアおよびコミュニティプラグインによる拡張性
単一および複数APIカタログのサポート
オープンソースで開発者ファーストのデザイン
APIカタログの追跡およびラベリング機能
Zudokuの使い方は？
CLIのインストール: `npm create zudoku @latest`を実行
プロジェクトの初期化: `npm run zudoku install`を実行
OpenAPIスキーマの追加: Zudoku構成にスキーマを統合
外観のカスタマイズ: テーマとMDXを適用してブランドとスタイルを設定
エンドポイントのテスト: インタラクティブプレイグラウンドを使用してライブAPIテストを実行
ドキュメントのデプロイ: どこにでもホストできる静的ページを生成
Zudokuの使用例
- APIリファレンスドキュメント
- 開発者ポータル
- 内部APIドキュメント
- 複数APIカタログ
- インタラクティブAPIテスト
- ブランドドキュメント
- SEO最適化ドキュメント
