2016-12-11 18 views
0

Swaggerを使用してAPIを作成しました。ホスティングされたSwagger APIのライブスワッガーAPIページを生成するにはどうすればよいですか?

私の顧客は

https://theservice.com/data/items/category1/12345 

これは素晴らしいですし、[OK]を作品のように私のサービスへの呼び出しを行うことができるようになります。

しかし、SwaggerがSwaggerEditor appでそれを生成する方法と同様に、利用可能なすべてのAPI呼び出しを見ることができるページを用意したいと思います。たとえば、https://theservice.com/index.htmlにアクセスして、APIドキュメントを参照してください。

ライブシステムでこれを行うことは可能ですか(私が知っているswagger project editでローカルではありません)。 はいの場合、どうですか?

+0

「お客様は私のサービスに電話をかけることができません...」「あなたは顧客が今電話をかけられるようになる」と思っています。これは他のユーザーの質問を明確にするためです。 –

+0

@TedEpstein良いキャッチ、それを修正しました。それについて申し訳ありません – CodyBugstein

答えて

3

Swagger Editorを使用してAPIを記述し、組み込みジェネレータを使用して足場コードを生成しているようです。あなたのタグから、私はこれがnode.jsコードであると仮定します。このAPI実装を完了するには、生成したコードに独自のロジックを追加する必要があります(まだ実行していない場合)。

これが正しい場合、探しているインタラクティブなSwagger-UIドキュメントは、実行中のサービスのベースURLを基準にして、/docsエンドポイントの生成APIで利用できるはずです。

生成されたnode.jsプロジェクトには、エディタで作成したSwagger仕様が含まれており、Swagger-Toolsを使用してランタイムマジックを実行します。 Swagger-Toolsは、Swagger仕様を/docsエンドポイントに自動配線し、Swagger仕様で提供された情報に基づいて、生成されたコントローラへの要求のルーティングを管理します。

/docsページは、スワッガーエディタに表示されるドキュメントウィジェットとは多少異なります。アプリケーションの1つは、対話型のサンドボックステストを使用して、ドキュメントのランタイムコンポーネントであるSwagger-UIを使用します。 Swagger-Editorには独自のドキュメントUIが組み込まれていますが、現在はSwagger-Editorの外で使用するためにパッケージ化されていません。

Swaggerエディタとコードジェネレータとは別にAPIを実装済みの場合でも、既存のAPI実装にSwagger-Toolsを組み込む方法を確認するためにnode.jsコードを生成できます。または、wing328のように、Swagger-UIをご覧になり、独自のドキュメントページを追加する方法をご覧ください。

+0

説明的な答えをありがとう – CodyBugstein

1

私は、あなたが探していることはswagger-uiであり、ここでの例だと思う:http://petstore.swagger.io/

あなたが見ることができるように、それはすべての利用可能なAPIエンドポイントを示していますが、また、それをしようとする訪問者(開発者)ことができますだけでなく、ウェブページに直接掲載することができます。

+0

はい、それは私が探しているものです。ありがとう – CodyBugstein

関連する問題