Qiita Teams that are logged in
You are not logged in to any team

Log in to Qiita Team
OrganizationEventAdvent CalendarQiitadon (β)
Qiita JobsQiita ZineQiita Blog
Help us understand the problem. What are the problem?

More than 3 years have passed since last update.


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

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

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


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

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

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

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

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

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

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Help us understand the problem. What are the problem?