新しいSwaggerHubエディターの紹介：より高速なAPI設計のためのよりスマートなエディター

2017年3月7日

SwaggerHubは、Swaggerを使用してAPIを設計、ドキュメント化、構築するための最速かつ最も使いやすいプラットフォームを提供することに常に注力してきました。SwaggerHubプラットフォームの中心にあるのは、適切なフィードバックとヘルプでAPIを設計およびドキュメント化できる強力なクラウドベースのエディターです。SwaggerHubを立ち上げて以来、ユーザーからエディターに最も求めているものや、ニーズを満たすためにエディターの機能を改善する方法について多くのフィードバックが寄せられました。過去数か月間、SwaggerHubチームは、受け取ったフィードバックに基づいて、いくつかの重要な改善を実装するために熱心に取り組んできました。エディターに導入された新機能に加えて、あらゆるサイズのSwaggerファイルの設計ワークフローを円滑にするために、エディターの速度と安定性を向上させるための裏方の作業が多数行われました。今すぐログインして、新しいSwaggerHubエディターをお試しください。(SwaggerHubユーザーではありませんか？無料でサインアップ。) SwaggerHubエディターの新機能と、これらの新機能がSwaggerHubでより良いAPIを設計するのにどのように役立つかについて詳しく見ていきましょう。

新しい統一されたエディター

SwaggerHubは、エディターのAPIのYAML構文とUIで生成されたインタラクティブなAPIドキュメントを簡単に切り替える機能を提供してきました。しかし、ユーザーからは、エディターとUIを独立して操作したいというフィードバックも寄せられました。そのため、新しいSwaggerHubエディターでは、分割ビュー、エディターのみ、UIのみのビューを切り替える機能を追加しました。エディターのサイズを簡単に変更して、Swagger定義の操作を容易にすることができます。また、画面上部の表示タブをクリックしてビューを切り替えることができます。 SHSplit

インテリジェントな自動提案による高速編集

SwaggerHubエディターは構文のオートコンプリートを提供しており、これにより設計プロセスを高速化し、構文作成時の一般的なエラーを減らすのに役立ちます。改善されたエディターは、よりインテリジェントな自動提案で自動提案機能をさらに拡張することで、API設計プロセスの最前線にスピードをもたらします。記述中に、SwaggerHubエディターで常に利用可能だった自動生成されたスニペットとキーワードは引き続き表示されますが、作業中の仕様のセクションに基づいて、より具体的な提案も表示されます。たとえば、Swagger定義の「schemes」を更新している場合、新しいエディターは、その値に接続されている配列項目を提案します。または、配列の下にマップがあるタグなどの場合、配列項目のみが表示され、そこからキーワードを選択できます。 autosuggest1

「Ctrl+スペース」をクリックすると、いつでも推奨事項を表示することもできます。

より実用的なエラーメッセージ

SwaggerHubエディターは、常にリアルタイムの検証とエラーメッセージを提供し、設計プロセスをガイドし、Swagger（OpenAPI）標準を満たすようにしてきました。チームは、Swagger定義を作成する際によく発生するエラーを理解することに熱心に取り組んでおり、エラー警告を更新して、発生したエラーを修正するのに役立つ、より実用的な洞察を提供しています。更新されたエラーメッセージの最初のラウンドをリリースしました。今後も、Swaggerユーザーの最も一般的なユースケースに対応するために、将来のリリースでこれらのメッセージを更新していきます。 Validator Error

仕様の同じ行に複数のコメント

チームはSwaggerHubを使用して、あらゆるAPIの設計とドキュメント作成で共同作業を行うことができます。新しいSwaggerHubエディターで利用できる、小さな — しかし非常に要望の多かった — コラボレーションの改善点は、仕様の単一の行に複数のコメントを書き込む機能です。 Comments

これにより、APIで作業しているチームメイトは、仕様の同じ行で個別の問題を提起し、コメントし、フィードバックを提供し、個別の会話を最後まで追跡することができます。

新しいエディターを自分で試す

SwaggerHubエディターへのこれらの最新のアップデートを発表できることを嬉しく思います。今すぐログインして、ご自身でお試しください。 コメント、質問、フィードバックがありますか？以下のコメントでお知らせください。