Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cbornet/generator-jhipster-grpc
JHipster module, Adds support for gRPC and generates gRPC CRUD services
https://github.com/cbornet/generator-jhipster-grpc
generator grpc jhipster spring-boot yeoman-generator
Last synced: 20 days ago
JSON representation
JHipster module, Adds support for gRPC and generates gRPC CRUD services
- Host: GitHub
- URL: https://github.com/cbornet/generator-jhipster-grpc
- Owner: cbornet
- License: apache-2.0
- Created: 2017-02-08T18:44:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:22:15.000Z (about 2 years ago)
- Last Synced: 2024-12-24T08:12:17.899Z (29 days ago)
- Topics: generator, grpc, jhipster, spring-boot, yeoman-generator
- Language: Java
- Homepage:
- Size: 2.62 MB
- Stars: 44
- Watchers: 5
- Forks: 7
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-jhipster-grpc
[![NPM version][npm-image]][npm-url] [![Build Status][github-actions-image]][github-actions-url] [![Dependency Status][daviddm-image]][daviddm-url]
> JHipster module, Adds support for gRPC and generates gRPC CRUD services
# Introduction
This is a [JHipster](http://jhipster.github.io/) module, that is meant to be used in a JHipster application.
WARN : Under developpement. See list of limitations and TODOs
# Prerequisites
As this is a [JHipster](http://jhipster.github.io/) module, we expect you have JHipster and its related tools already installed:
- [Installing JHipster](https://jhipster.github.io/installation.html)
# Installation
To install this module:
```bash
npm install -g generator-jhipster-grpc
```
Compatibility :
- JHipster 4.1 and inferior (Note : never tested with <4.1.0) : module version 0.7.0
- JHipster 4.2 and 4.3 : module version 0.8.0, 0.9.0
- JHipster 4.4 : module version 0.10.0
- JHipster 4.5 to 4.8 : module version 0.11.0
- JHipster 4.9 : module version 0.12.0, 0.13.0
- JHipster 4.10 : module version 0.14.1
- JHipster 4.11 to 4.14 : module version 0.15.2
- JHipster 5.0 to 5.7 : module version 0.16.0
- JHipster 5.8: module version 0.17.0
- JHipster 6.0: module version 0.18.0
- JHipster 6.1 and 6.2: module version 0.19.1
- JHipster 6.3: module version 0.20.0
- JHipster 6.4 and 6.5: module version 0.21.2 0.22.0
- JHipster master : module branch next-jhipster (nightly build status : [![Build Status][github-actions-image-nightly]][github-actions-url])
# Usage
At the root of your project directory:
```bash
yo jhipster-grpc
```
This will configure [reactive-grpc](https://github.com/salesforce/reactive-grpc) and [grpc-spring-boot-starter](https://github.com/LogNet/grpc-spring-boot-starter)
so that the proto files present in `src/main/proto` are compiled.
If you want to add CRUD gRPC services for an entity, just (re)generate it and confirm when the question is asked.
The endpoints use Reactor implementation of reactive-streams (Flux) with back-pressure.
Notes :
* for the moment entities must have a service layer (serviceClass or serviceImpl)
* just like with DTOs, entities that are referenced by another entity in a relationship (many-to-many owned side, many-to-one or one-to-ine owned side) currently must be grpc activated and thus have a service layer. The service layer constraint should be relaxed in a future release since it's only the gRPC mapper which is required.
TODOs:
- [x] ~~Generate existing entities~~
- [x] ~~Support Gradle~~
- [x] ~~Entities without DTOs~~
- [ ] Entities without service
- [x] ~~Entities with pagination~~
- [x] ~~Support Cassandra~~
- [x] ~~Support Mongo~~
- [x] ~~Support relationships~~
- [x] ~~JWT security~~
- [x] ~~OAuth2 security~~
- [x] ~~Basic auth security~~ (used for session auth option)
- [x] ~~Entity javadoc~~
- [x] ~~Field javadoc~~
- [x] ~~Add ElasticSearch endpoints~~
- [x] ~~Management endpoints~~
- [x] ~~Account~~
- [x] ~~Loggers~~
- [x] ~~Audits~~
- [x] ~~Users~~
- [x] ~~Profile info~~
- [x] ~~Spring Boot Actuators~~
- [ ] Support streaming from the DB (Stream<> in repository)
- [x] ~~Support streaming back-pressure (reactive streams with rxJava2 or Reactor)~~
- [ ] Client-side configuration (micro-services)
- [ ] Client-side load-balancing with service discovery (micro-services)
- [ ] Generator tests
- [ ] Sample/demo project
- [x] ~~Generated code tests~~
- [x] ~~Travis CI~~
Mappings:
| JHipster | Protobuf |
|:--------:|:-------------:|
| Integer | int32 |
| Long | int64 |
| String | string |
| Float | float |
| Double | double |
| Boolean | bool |
| Blob (byte[]) | bytes |
| ByteBuffer | bytes |
| Instant | google.protobuf.Timestamp |
| ZonedDateTime | google.protobuf.Timestamp |
| LocalDate | util.Date |
| BigDecimal | util.Decimal |
| enum | enum |
util.Date and util.Decimal are custom definitions.
Non-required protobuf scalar types and enums are wrapped in OneOf types to provide nullability.
# License
Apache-2.0 © [Christophe Bornet]
[npm-image]: https://img.shields.io/npm/v/generator-jhipster-grpc.svg
[npm-url]: https://npmjs.org/package/generator-jhipster-grpc
[github-actions-image]: https://github.com/cbornet/generator-jhipster-grpc/workflows/Applications/badge.svg
[github-actions-image-nightly]: https://github.com/cbornet/generator-jhipster-grpc/workflows/Applications/badge.svg?branch=next-jhipster
[github-actions-url]: https://github.com/cbornet/generator-jhipster-grpc/actions
[daviddm-image]: https://david-dm.org/cbornet/generator-jhipster-grpc.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/cbornet/generator-jhipster-module