JHipster API FirstDepelop
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
単語検索
|
最終更新
|
ヘルプ
]
開始行:
[[JHIPSTER一覧]]
#contents
* JHipsterでAPIを定義書から作成 [#g6a1a603]
jhipsterで、アプリの初期設定時の選択肢にでてくる
API first development using OpenAPI-generator
を詳しく見ていきたいと思います。これは、Swagger v2 と Ope...
APIの最初の開発では、コードからドキュメントを生成する代わ...
** メリット [#x0e4669e]
- 実装の前に、資料を用意できるので、レビュー資料として使...
- モックを生成することができる
- 確認用のサーバを用意しなくてもよくなる
** OpenAPI v3で設計したファイルの置き場所 [#cdfd1a7c]
OpenAPI仕様ファイルは
src/main/resources/swagger/api.yml
に置きます。
-
-
*** 確認用のダミーなクラスとかAPIとかの設定 [#o68d1d01]
vscodeで、swaggerのツールがあるので、それを入れるといいと...
サンプルとして、以下のリクエストクラスがあって、DBにも...
class Hoge {
private String param1;
private String param2;
}
*** swaggerエディタ [#j5e8f1e0]
*** ローカルでswagger deitorを使いたい場合 [#a2c984f4]
git clone https://github.com/swagger-api/swagger-editor....
*** インストールなしでswagger deitorを使いたい場合 [#qc72...
https://editor.swagger.io/
*** 起動後に出てくるAPI定義書のサンプルをみて一言 [#c14cd...
swaggerエディタを使うと文法の確認をしながら、設計を進める...
文法が決まっているので、プログラムを覚えるような感じです...
*** サンプルの仕様書の場所 [#t9a85291]
https://github.com/OAI/OpenAPI-Specification/tree/master/...
サンプルとして、ペットショップのAPIが用意されています。
このサンプルをにらめっこして、どこに値を入れたらいいのか...
ファイルは、vscodeのswagger viewerプラグインで見るとよい...
shift + Alt + P で ビューワーが起動します。いろいろ、プ...
* OpenAPIで使う型 [#r1e28ffc]
クラスに相当するのが、openapiのdefinitionのようです。
ここには、実際に、PetShopのサンプルを見ながら、あてはめて...
でも、型がわかんないよ!となるとおもいますので、まずは、
OpenAPIで使う型は、簡単なバリデーションチェックも指定でき...
https://swagger.io/docs/specification/data-models/data-ty...
*** 型には、formatが指定できる [#j7e724ab]
型の数少ないとおもいましたか?日付とかないですよね。実は...
integerだと、int32、int64
numberだと、float、double
stringだと、なにもなし、byte、binary、date、date-time、em...
*** クラス図をopenapiのdefinitionに置き換える [#l76c077f]
*** コツ [#s499ca3f]
近そうなメソッドをサンプルからチョイスして、値を書き換え...
** jhipsterのサイトのAPI生成解説 [#iac5b253]
https://www.jhipster.tech/doing-api-first-development/
です。
** ソースコード上でのAPI生成の設定箇所 [#e53ef39c]
OpenApiConfigurationクラスでSwaggerにしているような感じで...
終了行:
[[JHIPSTER一覧]]
#contents
* JHipsterでAPIを定義書から作成 [#g6a1a603]
jhipsterで、アプリの初期設定時の選択肢にでてくる
API first development using OpenAPI-generator
を詳しく見ていきたいと思います。これは、Swagger v2 と Ope...
APIの最初の開発では、コードからドキュメントを生成する代わ...
** メリット [#x0e4669e]
- 実装の前に、資料を用意できるので、レビュー資料として使...
- モックを生成することができる
- 確認用のサーバを用意しなくてもよくなる
** OpenAPI v3で設計したファイルの置き場所 [#cdfd1a7c]
OpenAPI仕様ファイルは
src/main/resources/swagger/api.yml
に置きます。
-
-
*** 確認用のダミーなクラスとかAPIとかの設定 [#o68d1d01]
vscodeで、swaggerのツールがあるので、それを入れるといいと...
サンプルとして、以下のリクエストクラスがあって、DBにも...
class Hoge {
private String param1;
private String param2;
}
*** swaggerエディタ [#j5e8f1e0]
*** ローカルでswagger deitorを使いたい場合 [#a2c984f4]
git clone https://github.com/swagger-api/swagger-editor....
*** インストールなしでswagger deitorを使いたい場合 [#qc72...
https://editor.swagger.io/
*** 起動後に出てくるAPI定義書のサンプルをみて一言 [#c14cd...
swaggerエディタを使うと文法の確認をしながら、設計を進める...
文法が決まっているので、プログラムを覚えるような感じです...
*** サンプルの仕様書の場所 [#t9a85291]
https://github.com/OAI/OpenAPI-Specification/tree/master/...
サンプルとして、ペットショップのAPIが用意されています。
このサンプルをにらめっこして、どこに値を入れたらいいのか...
ファイルは、vscodeのswagger viewerプラグインで見るとよい...
shift + Alt + P で ビューワーが起動します。いろいろ、プ...
* OpenAPIで使う型 [#r1e28ffc]
クラスに相当するのが、openapiのdefinitionのようです。
ここには、実際に、PetShopのサンプルを見ながら、あてはめて...
でも、型がわかんないよ!となるとおもいますので、まずは、
OpenAPIで使う型は、簡単なバリデーションチェックも指定でき...
https://swagger.io/docs/specification/data-models/data-ty...
*** 型には、formatが指定できる [#j7e724ab]
型の数少ないとおもいましたか?日付とかないですよね。実は...
integerだと、int32、int64
numberだと、float、double
stringだと、なにもなし、byte、binary、date、date-time、em...
*** クラス図をopenapiのdefinitionに置き換える [#l76c077f]
*** コツ [#s499ca3f]
近そうなメソッドをサンプルからチョイスして、値を書き換え...
** jhipsterのサイトのAPI生成解説 [#iac5b253]
https://www.jhipster.tech/doing-api-first-development/
です。
** ソースコード上でのAPI生成の設定箇所 [#e53ef39c]
OpenApiConfigurationクラスでSwaggerにしているような感じで...
ページ名: