- 追加された行はこの色です。
- 削除された行はこの色です。
[[JHIPSTER]]
[[JHIPSTER一覧]]
*** jhipsterのapi.ymlの場所 [#u1f8d232]
** JHIPSTER本家のOPENAPIの説明 [#h6ec5142]
https://www.jhipster.tech/doing-api-first-development/
** jhipsterのapi.ymlの場所 [#u1f8d232]
src/main/resources/swagger/api.yml
** サンプルAPI [#ofd48b67]
デフォルトでは、セキュリティに関する記述はあるが何もAPIが記載されていない。
なので、以下のコードをapi.ymlに追加して確認するとする
/health:
get:
operationId: openapitutorial.controller.health.call
summary: サーバーの状態を返します
description: サーバーの状態を返します。
responses:
'200':
description: サーバーは正常に動作しています
content:
application/json:
schema:
$ref: '#/components/schemas/get_health_response'
components:
schemas:
get_health_response:
description: サーバーの状態のレスポンス
type: object
properties:
status:
type: string
enum:
- ok
required:
- status
*** おもったこと [#r18b1389]
個人的には、getメソッドとpostメソッドなど、swaggerのアノテーションを付ける箇所は
自動的に生成すればいいのにと思う。