Skip to content
This repository has been archived by the owner on Dec 6, 2024. It is now read-only.

Latest commit

 

History

History
66 lines (44 loc) · 1.85 KB

README.md

File metadata and controls

66 lines (44 loc) · 1.85 KB

generator-jhipster-apiutils

NPM version Build Status Dependency Status

A Jhipster module with some utilities for api first development

Introduction

This is a JHipster module, that is meant to be used in a JHipster application. Thanks to this module its possibile to:

  • when enableSwaggerCodegen=true the api.yml file can be served statically by a dedicated endpoint
  • add api to service discovery tags in order to expose api version
  • integration with Fabio load balancer, when consul is enabled
  • replace swagger ui 2 with the new swagger ui 3 (BETA, works only with JWT authentication)

Prerequisites

As this is a JHipster module, we expect you have JHipster and its related tools already installed:

Installation

With Yarn

To install this module:

yarn global add generator-jhipster-apiutils

To update this module:

yarn global upgrade generator-jhipster-apiutils

With NPM

To install this module:

npm install -g generator-jhipster-apiutils

To update this module:

npm update -g generator-jhipster-apiutils

Usage

yo jhipster-apiutils

License

Apache-2.0 © Enrico Costanzi