Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jkyberneees/hydra-integration
Minimalist 'hydra integration' module, intended for Node.js web frameworks integration.
https://github.com/jkyberneees/hydra-integration
Last synced: 3 months ago
JSON representation
Minimalist 'hydra integration' module, intended for Node.js web frameworks integration.
- Host: GitHub
- URL: https://github.com/jkyberneees/hydra-integration
- Owner: jkyberneees
- License: mit
- Created: 2017-03-19T13:09:04.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T03:53:41.000Z (about 2 years ago)
- Last Synced: 2024-10-12T13:38:20.471Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 729 KB
- Stars: 14
- Watchers: 3
- Forks: 4
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- cuban-opensource - hydra-integration
README
# Hydra Integration Module
Integrating third-party Node.js web frameworks with Hydra, the simplest way.
> Hydra is a NodeJS package, which facilitates building distributed applications such as Microservices.
> (https://www.hydramicroservice.com/)
The magic thing with Hydra is that with a minimum setup, your micro-service get 'superpowers':
- Distributed Computing
- Application Clusters + Load Balancer
- High Availability
- Centralized Proxy Router
- Realtime Messaging
- Service Discovery, Monitoring and Management
- ... and much more (https://www.hydramicroservice.com/)
By using this module, you will be able to easily integrate your prefered web framework with hydra. Just keep reading...
## Integrated frameworks
At the moment, the following frameworks are supported:
1. **Express**: Fast, unopinionated, minimalist web framework for Node.js... (http://expressjs.com/)
2. **Hapi**: A rich framework for building applications and services, hapi enables developers to focus on writing reusable application logic instead of spending time building infrastructure... (https://hapijs.com/)
3. **Koa**: Koa is a new web framework designed by the team behind Express, which aims to be a smaller, more expressive, and more robust foundation for web applications and APIs... (http://koajs.com/)
4. **Sails.js**: Sails makes it easy to build custom, enterprise-grade Node.js apps... (http://sailsjs.com/)
5. **Restify**: Restify is a node.js module built specifically to enable you to build correct REST web services... (http://restify.com/)
6. **Restana**: Super fast and minimalist web framework for building REST micro-services... (https://github.com/jkyberneees/ana)
7. **Native Hydra Service**: Hydra services are ideal for making distributed API calls through HTTP or real-time events management... (https://www.hydramicroservice.com/)
## Getting Started
Next we will explain you how to create and express based micro-service on top of hydra:
> IMPORTANT: Hydra depends on Redis database server for storage, cache and messaging. In case you don't have it yet: https://www.hydramicroservice.com/docs/quick-start/step1.html
1. Install dependencies:
```bash
npm i hydra hydra-integration express --save
```
> Express is a dependency here because in the next example we use express, it could be koa or hapi, or any of the supported frameworks.
2. Create and edit app.js file:
```js
const HydraServiceFactory = require('hydra-integration').HydraServiceFactory;
const express = require('express');
const router = express.Router();
const factory = new HydraServiceFactory({
hydra: {
'serviceName': 'express-service-test',
'serviceDescription': 'Basic express service on top of Hydra',
'serviceIP': '127.0.0.1',
'servicePort': 3000,
'serviceType': 'express',
'serviceVersion': '1.0.0',
'redis': {
'host': '127.0.0.1',
'port': 6379,
'db': 15
}
}
});
factory.init().then(factory => factory.getService(service => {
router.get('/welcome', (req, res) => res.send('Hello World!'));
service.use('/v1', router);
}));
```
Alternative way of getting the service instance by passing config params to the builder (if supported):
```js
factory.init().then(factory => factory.getService({
// optional config params here to be passed to the building strategy
bootstrap: service => {
router.get('/welcome', (req, res) => res.send('Hello World!'));
service.use('/v1', router);
}
}));
```
> To use hydra-integration as a plugin see: [The HydraIntegrationPlugin class](https://github.com/jkyberneees/hydra-integration/blob/master/docs/HydraIntegrationPlugin.md)
3. Run your service:
- Single process:
```bash
node app.js
```
- Optionally you can run multiple processes with [PM2](http://pm2.keymetrics.io/docs/usage/cluster-mode/):
```bash
pm2 start app.js -i 4
```
4. Test your service using a Web browser at: http://localhost:3000/v1/welcome
5. Test the service using the hydra-cli (https://www.hydramicroservice.com/docs/tools/hydra-cli/getting-started.html):
- List service routes
```bash
hydra-cli routes express-service-test
```
```json
{
"serviceName": [
"[GET]/_health",
"[GET]/v1/welcome"
]
}
```
- Invoke the [GET]/v1/welcome service endpoint:
```bash
hydra-cli rest express-service-test:[GET]/v1/welcome
```
```json
{
"headers": {
"x-powered-by": "Express",
"content-type": "text/html; charset=utf-8",
"content-length": "12",
"etag": "W/\"c-Lve95gjOVATpfV8EL5X4nxwjKHE\"",
"date": "Wed, 05 Apr 2017 21:22:51 GMT",
"connection": "close"
},
"body": "Hello World!",
"statusCode": 200
}
```
## Demos
Demos available into [demos folder](demos) on the git repository: https://github.com/jkyberneees/hydra-integration
## Next Topics
- [The HydraServiceFactory class](docs/HydraServiceFactory.md)
- [The HydraIntegrationPlugin class](docs/HydraIntegrationPlugin.md)
- [Express Framework Integration](docs/ExpressIntegration.md)
- [Hapi Framework Integration](docs/HapiIntegration.md)
- [Koa Framework Integration](docs/KoaIntegration.md)
- [Sails(0.x) Framework Integration](docs/Sails0Integration.md)
- [Restify Framework Integration](docs/RestifyIntegration.md)
- [Restana Framework Integration](docs/RestanaIntegration.md)
- [Native Hydra Integration](docs/NativeIntegration.md)
- [Creating your own integration](docs/CustomIntegration.md)
- [Reference documentation](https://www.hydramicroservice.com/)
## Complementary Topics
- [The Hydra Router](https://github.com/flywheelsports/hydra-router/blob/master/README.md)