新しいビジュアルSwaggerHubエディターでOpenAPI仕様を文書化

  2019年4月23日

組織がSwaggerHubでAPIドキュメントを作成し、公開APIドキュメントを共有することを容易にする新しい機能強化を発表できることを嬉しく思います。

OAS定義を文書化するための新しいビジュアルエディター

SwaggerHubのYAMLエディターで直接作業することなく、API情報とメタデータを編集できるようになりました。

新しいビジュアル編集エクスペリエンスは、YAML構文に関する直接的な知識がないチームメンバーや、API情報(タイトル、説明、ライセンス、連絡先情報)や運用メタデータ(概要、説明、タグ)など、OAS定義内の重要な詳細を構築する必要があるテクニカルライターに最適です。

ビジュアルエディターで行われた変更は、YAMLコードエディターと自動的に同期され、UIビューでリアルタイムに視覚化されます。エディターはMarkdown構文もサポートしており、YAMLエディターでは記述が面倒な技術文書に異なる形式とスタイルを適用できます。

注:これはSwaggerHubのビジュアルエディターの最初のリリースです。将来的には、エンドポイント、ヘッダー、ボディなどを記述するための拡張機能を追加する予定です。

新しいビジュアルエディターへのアクセス

ビジュアルエディターに切り替えるには、SwaggerHubエディターのサイドバーにある「ビジュアルエディターを表示」をクリックします。カーソルがYAMLコードの特定の操作内にある場合、その操作のビジュアルエディターが開きます。

Open-Visual-Editor.png

左側の「ナビゲーション」パネルで項目を選択します。ナビゲーションパネルが非表示になっている場合は、サイドバーの「ビジュアルエディターを表示」アイコンをクリックして表示します。

visual-editor-api-info.png

新しいビジュアルエディターを探索

Swagger UIドキュメントに会社のロゴとブランディングを追加

組織は、SwaggerHubでホストされているAPIドキュメントに独自のブランディングを追加できるようになりました。この新しいカスタマイズ可能なドキュメント機能は、SwaggerHubを活用して外部APIのドキュメントを共有している組織に最適です。

この新機能により、組織は会社のロゴをアップロードして標準のSwaggerHubロゴを置き換え、ヘッダーの色を企業のブランディングに合わせてカスタマイズできます。

Custom-Docs-Example.png

ドキュメントブランディングは、チームプランおよびエンタープライズプランの組織で利用できます。

新しいドキュメントブランディング機能へのアクセス

組織の所有者は、組織設定の「ドキュメントブランディング」ページでブランディングオプションを設定できます。

  1. ユーザー名をクリックし、「設定」を選択します。
  2. 「私の組織」タブに切り替えます。
  3. 左側のサイドバーで「ドキュメントブランディング」を選択します。

Docs-Branding.png

新しいドキュメントブランディング機能を探索

Azure DevOps Servicesとの統合

新しいAzure DevOps Services統合により、API定義、自動生成されたサーバーコード、またはクライアントSDKをAzure DevOps Services(旧Visual Studio Team ServicesまたはVSTS)の既存のGitリポジトリと同期できます。SwaggerHubでAPIを保存するたびに、統合は指定されたリポジトリのコードを更新します。

Azure DevOps Servicesとの統合は、SwaggerHubに追加された最新のソース管理統合であり、既存のGitHub、GitLab、Bitbucketとの統合も含まれます。

新しい統合へのアクセス

  1. SwaggerHubエディターでOAS 2.0またはOAS 3.0定義を開きます。
  2. APIに複数のバージョンがある場合は、Azure DevOps Servicesのリポジトリと同期するバージョンを選択します。

Open-SwaggerHub-Integrations.png

  1. API名をクリックしてAPI情報パネルを開きます。
  2. API情報パネルで、「統合」タブに切り替え、「新しい統合を追加」をクリックします。

Add-New-Integration.png

  1. 統合のリストから「Azure DevOps Services」を選択します。

Azure DevOps Services統合を探索

SwaggerHubを始めよう

これらすべての最新アップデートは、SwaggerHubチームおよびエンタープライズプランで利用可能です。 ログインしてご自身でお試しください、または今すぐ無料トライアルを開始してください