workshop-openapi

JHipster workshop to learn how to create an API with the API first design.

API-First Approach

To fully understand the workshop, you need to be familiar with the API-First design, you can find a lot of resources about it on the internet. I suggest you to start with reading this article: https://swagger.io/resources/articles/adopting-an-api-first-approach/

Prerequisites

For this JHipster workshop, you must install these softwares :

Tools	Command
Git	git version
Java 8/11	java -version
NodeJS (LTS 64-bit version)	node -v
NPM	npm -v
JHipster	jhipster --help

Use the command line above to test if softwares are installed and work as expected.

For more informations: https://www.jhipster.tech/installation/

Plan

1. Generate a JHipster application

2. Create a resource

3. Mock the api

4. Add a business code

5. Consume the workshop API with another JHipster application

Tools

IDE

You can choose your favorite IDE. To be effective having a swagger plugin is advised.

Some examples of plugin for the most populars IDE

• Eclipse
• IntelliJ
• VsCode

References

OpenApi specifications

Swagger editor