Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision Next revision Both sides next revision | ||
ja:how_to_use_swagger_ui_and_postman_for_biostar_2_new_local_api [2021/05/31 11:51] pjemoon created |
ja:how_to_use_swagger_ui_and_postman_for_biostar_2_new_local_api [2021/05/31 14:12] pjemoon [How to utilize Swagger UI] |
||
---|---|---|---|
Line 15: | Line 15: | ||
{{:en:newapi_1.png?nolink&700|}} \\ | {{:en:newapi_1.png?nolink&700|}} \\ | ||
- | We provide the information on BioStar 2 API through the Swagger UI so that you can check kinds of APIs and those model schemas before calling API. Below is an example for the way to utilize this tool by using login API.\\ \\ \\ | + | APIを呼び出す前に、APIの種類とそれらのモデルスキーマを確認できます。以下は、ログインAPIを使用してサービスを利用する方法です。\\ \\ \\ |
- | ==== How to utilize Swagger UI ==== | + | ==== Swagger UIの利用方法 ==== |
* <wrap em>POST /api/login API</wrap> | * <wrap em>POST /api/login API</wrap> | ||
- | 1) Click ‘Try it out’ button which located in the right upper corner to edit the request body. \\ | + | 1) 右上にある[Try it out]ボタンをクリックして、リクエストボディを編集します。\\ |
- | 2) Enter the values to login BioStar 2. \\ | + | 2) BioStar 2のログイン情報を入力します。 \\ |
- | 3) After enter the values, click ‘Execute’ button in below the screen to check the result about response message. \\ | + | 3) 画面下の「Execute」ボタンをクリックして、レスポンスメッセージの結果を確認します。 \\ |
| | ||
{{:en:newapi_2.png?nolink&700|}} \\ \\ \\ | {{:en:newapi_2.png?nolink&700|}} \\ \\ \\ |