generator-jhipster-swagger-api-first
JHipster module, JHipster module to support API first development using swagger
Introduction
This module uses the swagger-codegen-maven-plugin to bring API-first development to your JHipster application. In API first development, instead of generating the doc from the code, you first write the spec and generate the code from it. This has the following advantages:
- you design your API for the consumers and not as a consequence of your implementation.
- you can use it to mock your new server endpoints before they are released so you decouple more between frontend and backend dev
- you don't need a live server to use your swagger spec
Note : the module currently only works with Maven.
Prerequisites
As this is a JHipster module, we expect you have JHipster and its related tools already installed:
Installation
To install this module:
yarn global add generator-jhipster-swagger-api-first
Usage
At the root of your project
yo jhipster-swagger-api-first
This will configure the swagger-codegen-maven-plugin in your pom.xml so that, when you compile, the spec located at src/main/resources/swagger/api.yml
is used to generate endpoint interfaces that you can implement.
Those interfaces have default methods which answer with a 200 HTTP status and an empty body.
Write your spec using a tool such as swagger-editor, put it in src/main/resources/swagger/api.yml
, then :
./mvnw generate-sources
Then implement the interfaces generated in target/generated-sources/swagger/src/main/java/${package}/web/api/controller
with @RestController
classes.
Example of code to write yourself for the famous petstore spec:
@RestController
License
Apache-2.0 © Christophe Bornet