メインコンテンツまでスキップ

Cloud クイックスタート

この経路は仕様をあなたのマシンから共有可能なドキュメントページと MCP エンドポイントへ運びます。

1. ログイン​

ログインページで Google か GitHub で続けます。OAuth ハンドシェイク後、Powerduck が独自セッションを作りコンソールへ案内します。個人組織が自動作成されます。

2. 仕様を追加​

ダッシュボードで、対応ソースのいずれかから仕様を追加します。

  • ファイルアップロード——OpenAPI ファイルを直接アップロード。
  • Git リポジトリ——リポジトリを指し、ブランチとファイルパスを選ぶ。
  • URL——URL から仕様を取り込む。

既存の OpenAPI 3.0/3.1 と Swagger 文書はアップグレードされ、cURL や Postman 入力は保存前に変換してプレビューできます。

直接アップロードの仕組み​

大きなファイルは API 経由でなくオブジェクトストレージへ直接アップロードされます。

  1. 文書を作成する。
  2. アプリがコンテンツタイプとサイズでアップロード URL を請求する。
  3. ファイルが事前署名 URL 経由でストレージへ直接アップロードされる。
  4. アップロードを完了し、バージョンと SHA-256 を記録する。

これにより API サーバーが大きなペイロードのデータ経路に入りません。

3. 公開操作を選ぶ​

仕様が揃ったら、どの操作を公開するか選びます。個別に切り替えられ、元文書は変わりません。すべて有効から始め、内部や管理インターフェースで絞り込めます。

4. リンクを開く​

文書がアクティブになると、文書ワークスペースが公開アドレスを表示します。

  • Documentation——公開ビューアーのレンダリング API ドキュメント。
  • MCP——マネージド Streamable HTTP MCP エンドポイント。
  • 元仕様データも安定 URL で提供。

デフォルトでドキュメントは有効で、パスワード追加時のみ保護されます。MCP の可用性とアクセスキーは個別に構成します。

5. 必要ならアクセスを保護​

  • ドキュメントに閲覧パスワードと任意の有効期限を追加。
  • MCP エンドポイントに MCP アクセスキーを生成。
  • 文書を一時停止すると両方を一時的に落とせる。

6. バージョンで反復する​

API が変わるとき、旧版を置換せず新内容を新バージョンとしてアップロードします。共有リンクは現在文書を指すか特定バージョンに固定でき、あるバージョンを参照するリンクが読者の足下で変わることはありません。

次のステップ​