品質ドキュメントは、APIをわかりやすく、実装し、維持するために重要です。最も人気のあるAPIビジュアライゼーションツールの2つであるSwagger UIとRedocを使用して、OpenAPI仕様に基づいたドキュメントの自動生成を設定します。
これにより、メソッドの構造を学び、クエリをテストし、APIにすばやく接続できるインタラクティブなインターフェイスを開発者に提供できます。
ドキュメントに含まれているもの
| ［セクション］ | Description |
|---|---|
| エンドポイントとメソッド | ルートの完全なリスト、HTTPメソッド、パラメータ、ヘッダー |
| サンプルリクエスト/レスポンス | curl、 Postman、 JavaScript、 Pythonなどの言語のスクリプト |
| 承認（Authorization | インタフェースから直接JWT、 OAuth2、 APIキーのサポート |
| ファシリティダイアグラム | モデル、ネストされた構造、およびデータ要件の説明 |
| エラーコード | 説明付きの可能なすべてのステータス |
私たちが使用するツール
Swagger UI-ブラウザのインタラクティブなドキュメント、テスト機能
Redocは、サイト上での公開に最適な可読性のある静的インターフェイスです
OpenAPI 3。0/3.すべてがベースになっている1-The BOM形式
コードから自動生成-注釈、説明、バージョン、ドキュメントの更新が自動的に
JSON/YAML/HTMLへのエクスポート
チームとパートナーのための利点
新規開発者のオンボーディングを加速
統合エラーの削減
常に最新のコード同期ドキュメント
テクニカルサポートなしで統合へのクイックスタート
パブリックポータルまたはプライベートポータルにドキュメントを簡単に公開
特に重要な点
外部開発者向けのオープンAPI
アクティブな開発を伴う内部API
B2B統合とSDKを備えたプラットフォーム
規制の要件とスキームの検証を伴うサービス