New openapi-cli subgenerator for OpenApi client generation #9623

ecostanzi · 2019-04-26T13:58:16Z

Create a sub-generator for generating clients from OpenAPI specs. Can be invoked using jhipster openapi-client. Open discussion in issue #9548.

TODO:

import code from https://github.com/cbornet/generator-jhipster-swagger-cli and create a sub-module
migrate from jar client to node openapi-generator-cli
add generator name for each spec in .yo-rc.json file (to allow FE client generation)
clean client code before regenerate

Jhipster checks:

Travis tests are green
Tests are added where necessary
Documentation is added/updated where necessary
Coding Rules & Commit Guidelines as per our CONTRIBUTING.md document are followed

.vscode/launch.json

package.json

murdos

I made a few comments here and there, I hope they're not irrelevant since I'm a bit lot on what we want to achieve exactly here.
I'm also worried to have yet another subgenerator in the main generator-jhipster to maintain. I think we should really foster the module/blueprint ecosystem, and have interesting but not essential feature available as optional module.

cli/commands.js

.vscode/launch.json

generators/openapi-cli/index.js

vwiencek · 2019-05-17T13:53:42Z

Hello, just 1 comment/question.

Implementation of REST based clients to allow inter-microservices communication (based on @FeignClient is very useful. I see to options to share DTOObjects between services:

option 1: have a shared library with all DTOObjects to make sure we keep them in sync ;
option 2: reimplement (or regenerate with openapi-cli) and have duplicated objects in different services.

I guess the good pattern is to keep microservices as isolated as possible, which means that we should prefer option 1 over option 2, right ?

murdos · 2019-05-18T22:14:10Z

I guess the good pattern is to keep microservices as isolated as possible, which means that we should prefer option 1 over option 2, right ?

FYI on my current project we're using a 3rd option: each microservice publish its swagger contract in Nexus, and other microservices that need to communicate with this microservice generate DTO objects at compile time from the published swagger contract.

ecostanzi · 2019-05-20T07:17:48Z

FYI on my current project we're using a 3rd option: each microservice publish its swagger contract in Nexus

@murdos that's interesting. How do you generate the spec file? I have read somewhere that it can be done with an integration test invoking the springfox endpoints.

murdos · 2019-05-20T07:58:02Z

@murdos that's interesting. How do you generate the spec file? I have read somewhere that it can be done with an integration test invoking the springfox endpoints.

That's exactly how we generate it indeed. I tried with https://github.com/kongchen/swagger-maven-plugin at build time, but the generated swagger was not reliable.

PierreBesson · 2019-06-20T07:27:11Z

@ecostanzi Do you need this merged and released before your talk at Jhipster conf ?

ecostanzi · 2019-06-20T11:06:55Z

@PierreBesson if the code looks good to you it would be nice! Let's see if the test pass. If so I'll add some more tests and mark the PR as ready for review.

generators/client/templates/angular/package.json.ejs

generators/client/templates/react/package.json.ejs

generators/server/templates/package.json.ejs

package.json

package-lock.json

ecostanzi · 2019-06-25T12:38:44Z

If it's ok for you members of the core team I'd like to do a demo preview of this feature during the talk at the jhipster conf. Otherwise if you prefer to take your time and review it before advertising it no problem, just tell me, i have something else to show.

PierreBesson · 2019-06-25T12:43:01Z

Or you can just show it from your branch

ecostanzi · 2019-06-25T12:51:21Z

@PierreBesson yes that's what I meant no need to have it in the main branch

DanielFran · 2019-08-26T23:44:02Z

@ecostanzi Can you fix conflicts and confirm when this PR can be reviewed? Thanks

PierreBesson · 2019-08-31T10:11:15Z

Hi everyone, let's move this forward, update the dependencies it introduces and merge this if this OK for you. For me it's important as a convergence of the OpenApiGenerator and JHipster projects.

See https://www.npmjs.com/package/@openapitools/openapi-generator-cli

ecostanzi · 2019-09-02T06:38:54Z

Hi, I've just rebased the branch and removed a couple of dependencies. It should be ok for now.

DanielFran · 2019-09-05T19:19:23Z

Restarted failing test

DanielFran · 2019-09-05T19:52:03Z

Many thanks @ecostanzi for the awesome work

vishal423 · 2019-09-11T05:38:07Z

generators/client/templates/react/package.json.ejs

@@ -164,6 +164,7 @@ limitations under the License.
    <%_ if (protractorTests) { _%>
    "webdriver-manager": "12.1.5",
    <%_ } _%>
+    "@openapitools/openapi-generator-cli": "0.0.14-4.0.2",


@ecostanzi,
It doesn't look appropriate to include generator sub-module dependency in the generated client application. Can't it be encapsulated in the module?

Hi Vishal, what do you mean by saying "encapsulated in the module"?

The documentations suggests:

It is recommended to install the package as development dependency, because normally you only need this dependency during the development process

https://www.npmjs.com/package/@openapitools/openapi-generator-cli#package-mode

Yes for me there is no problem to add this as dev dependency. Yes it does add significantly to what you have to download. But as it is useful, I don't see the problem of it being downloaded from npm rather than maven...

IMO, it should be added as generator-jhipster dependency (not under dev) and not in the client applications dev dependency. Can you check if that works?

Ok I'll let you know

@vishal423 I opened issue #10510 to discuss some changes. In that case I think that the dependency should remain in the package.json of the generated project.

@ecostanzi, I will leave it to other members to decide. For me, I am planning to create a separate module that wouldn't contain it.

cbornet reviewed Apr 26, 2019

View reviewed changes

.vscode/launch.json Outdated Show resolved Hide resolved

PierreBesson reviewed Apr 26, 2019

View reviewed changes

package.json Outdated Show resolved Hide resolved

murdos reviewed Apr 26, 2019

View reviewed changes

cli/commands.js Outdated Show resolved Hide resolved

.vscode/launch.json Outdated Show resolved Hide resolved

generators/openapi-cli/index.js Outdated Show resolved Hide resolved

DanielFran added area: enhancement 🔧 theme: openapi labels Jun 20, 2019

DanielFran requested changes Jun 20, 2019

View reviewed changes

PierreBesson requested a review from cbornet June 20, 2019 16:35

ecostanzi marked this pull request as ready for review June 21, 2019 08:36

DanielFran approved these changes Jul 3, 2019

View reviewed changes

PierreBesson approved these changes Aug 31, 2019

View reviewed changes

ecostanzi added 9 commits September 2, 2019 08:30

import swagger cli as sub-generator

a6326a1

fix openapi-cli index.js to make it work as sub-generator

5ce694a

use node openapi-generator-cli instead of jar file

e44fa1e

See https://www.npmjs.com/package/@openapitools/openapi-generator-cli

fix iteration over apis to regenerate

d14e955

add openapi-cli command description and USAGE file

e04e5f5

create promts.js and add generatorName property

e6cfa45

change module name to 'openapi-client'

05727d9

move writing phases to files.js

946851c

generates java files only with spring clients

641d631

ecostanzi added 13 commits September 2, 2019 08:31

remove package.json openapi-generator, use openapi-generator-cli jar

ee30c19

add test for openapi-client subgenerator

68d6a40

fix url composition when reading springfox swagger endpoint list

0b5c059

fix supportingFiles generation and fix test

af1426b

use openapi jar file in the node_modules of the generated project

c7d29f5

fix --regen option

807b7b4

update openapi-generator-cli to version 0.0.14-4.0.2

1d719c9

test for regeneration and component scan exclusion

e95a239

clean previously generated code before regenerating client

7163192

fix file path validation for custom endpoint

bfb1256

fix how the swagger-resources endpoint is built

f96ecbb

use shelljs and lodash instead of fs-extra and underscore.string

2cc6672

update package-lock.json

374f578

DanielFran merged commit 1bc7b60 into jhipster:master Sep 5, 2019

ecostanzi deleted the openapi-cli branch September 6, 2019 07:54

pascalgrimaud added this to the 6.3.0 milestone Sep 10, 2019

vishal423 reviewed Sep 11, 2019

View reviewed changes

SudharakaP mentioned this pull request Oct 6, 2019

Add Support for Microservices in GAE #10345

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New openapi-cli subgenerator for OpenApi client generation #9623

New openapi-cli subgenerator for OpenApi client generation #9623

ecostanzi commented Apr 26, 2019 •

edited

murdos left a comment

vwiencek commented May 17, 2019

murdos commented May 18, 2019

ecostanzi commented May 20, 2019

murdos commented May 20, 2019

PierreBesson commented Jun 20, 2019

ecostanzi commented Jun 20, 2019

ecostanzi commented Jun 25, 2019

PierreBesson commented Jun 25, 2019

ecostanzi commented Jun 25, 2019

DanielFran commented Aug 26, 2019

PierreBesson commented Aug 31, 2019

ecostanzi commented Sep 2, 2019

DanielFran commented Sep 5, 2019

DanielFran commented Sep 5, 2019

vishal423 Sep 11, 2019

ecostanzi Sep 11, 2019

PierreBesson Sep 11, 2019

vishal423 Sep 11, 2019

ecostanzi Sep 11, 2019

ecostanzi Sep 28, 2019

vishal423 Sep 30, 2019

New openapi-cli subgenerator for OpenApi client generation #9623

New openapi-cli subgenerator for OpenApi client generation #9623

Conversation

ecostanzi commented Apr 26, 2019 • edited

murdos left a comment

Choose a reason for hiding this comment

vwiencek commented May 17, 2019

murdos commented May 18, 2019

ecostanzi commented May 20, 2019

murdos commented May 20, 2019

PierreBesson commented Jun 20, 2019

ecostanzi commented Jun 20, 2019

ecostanzi commented Jun 25, 2019

PierreBesson commented Jun 25, 2019

ecostanzi commented Jun 25, 2019

DanielFran commented Aug 26, 2019

PierreBesson commented Aug 31, 2019

ecostanzi commented Sep 2, 2019

DanielFran commented Sep 5, 2019

DanielFran commented Sep 5, 2019

vishal423 Sep 11, 2019

Choose a reason for hiding this comment

ecostanzi Sep 11, 2019

Choose a reason for hiding this comment

PierreBesson Sep 11, 2019

Choose a reason for hiding this comment

vishal423 Sep 11, 2019

Choose a reason for hiding this comment

ecostanzi Sep 11, 2019

Choose a reason for hiding this comment

ecostanzi Sep 28, 2019

Choose a reason for hiding this comment

vishal423 Sep 30, 2019

Choose a reason for hiding this comment

ecostanzi commented Apr 26, 2019 •

edited