LoginSignup
2
1

More than 5 years have passed since last update.

CData API Server で作ったAPI からSwagger ドキュメントを生成する

Last updated at Posted at 2017-08-03

今回は、CData API Server を使ってDB から5分で作ったAPI に対し、Swagger Editor を使って、Swagger ドキュメントとして生成する方法を紹介します。先に結論を言うと「ツールって楽ですよ」。

CData API Server でDB からREST API およびドキュメントを生成

前の記事を参照して下さい。
http://qiita.com/jonathanh/items/fcd9aca3c1eb52206102

Swagger ドキュメント生成用のJSON の生成

API Server のドキュメントを開きます。
[/api.rsc/$swagger]をクリックして、GET メソッド[http://localhost:8387/api.rsc/$swagger]をブラウザに入力します。
as13.png

返ってきたJSON をそのままコピーします。

Swagger Editor でSwagger ドキュメントを生成

http://editor.swagger.io/ でSwagger Editor を開きます。
左側に今コピーしたJSON をそのまま貼り付けます。
それだけでSwagger ドキュメントが右側に自動生成されます。
as17.png

生成したSwagger エンドポイントで、Microsoft Azure Logic Apps などのSwagger エンドポイントに対応したサービスで、CData API Server のAPI を使用することができます。
DB からREST API を作るのに5分、Swagger エンドポイント化するのに1分くらいです。標準っていいですね。

2
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
1