FIXME このページはまだ完全には、翻訳されません。翻訳の完了を支援して下さい。
(翻訳が完了したらこの段落を削除して下さい)


Swagger UI

REST API を簡単にテストおよびドキュメント化するのに役立つツールです。

[REST APIのリクエストメソッド]


New Local APIの使用をお勧めします。以下のリンクでBioStar 2 New Local APIをご利用いただけます。
https://[BioStar 2サーバIP]:[BioStar 2ポート]/swagger/index.html


APIを呼び出す前に、APIの種類とそれらのモデルスキーマを確認できます。以下は、ログインAPIを使用してサービスを利用する方法です。


Swagger UIの利用方法

  • POST /api/login API

1) 右上にある[Try it out]ボタンをクリックして、リクエストボディを編集します。
2) BioStar 2のログイン情報を入力します。
3) 画面下の「Execute」ボタンをクリックして、レスポンスメッセージの結果を確認します。




Swagger UIとPostmanを使用する方法

PostmanはAPIコールの結果を簡単に確認できるアプリです。Postmanを使用すると、複雑なHTTPをすばやく作成し、コレクションに整理して、共有できます。 APIコール履歴も残ります。

PostmanはGoogleで検索してダウンロードできます。
Postmanダウンロード

  • POST /api/login API

Swagger UIで
1) ボディのデータをコピーします。

Postmanで
2) ドロップボックスでPOSTを選択し、ログインAPIを呼び出すためのURLを入力します。
i.e) https://192.128.16.35:456/api/login
3) Body選択 – raw – JSON(application/json).
4) Swagger UIからコピーしたデータをPostmanに貼り付けます。
5) ログイン情報をを入力します。
6) Sendをクリックします。
7) レスポンス結果は、セクションの下部に表示されます。



  • GET /api/users API

In the Postman ..
1) PostmanでログインAPIを実行します。
2) ログインに成功したら、レスポンスのヘッダーにある「bs-session-id」の値をコピーします。
3) ドロップボックスでGETを選択してから、取得ユーザーAPIを呼び出すためのURLを入力します。
i.e) https://192.168.16.35:456/api/users
4) [ヘッダー]を選択し、[Bulk Edit]をクリックします。
5) 以下のように値を入力します。
bs-session-id:[2でコピーした値]
content-type:application/json
6) Sendをクリックします。
7) レスポンス結果は、セクションの下部に表示されます。