# gateway-helper

**Repository Path**: samyuan/gateway-helper

## Basic Information

- **Project Name**: gateway-helper
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2018-11-29
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Gateway Helper
Permissions check, traffic restrictions service. Authenticating and limiting the requests from `api-gateway`, create JWT and return to `api-gateway`. You can specify which `gateway-helper` to go through `manager-service`, and configure the request to use the default `gateway-helper` or the customized `gateway-helper` for authentication and traffic restriction. At the same time, the service does not need to be restarted after the modification.

![流程图](screenshot/flow_chart.png)

## Feature
- Add a custom `gateway-helper` demo

## Requirements
- This service is an eureka client service. To run in local, we need to cooperate with `eureka-server`, and the online operation needs to cooperate with `go-register-server`.
- Need to cooperate with `api-gateway` to complete the gateway functions such as authentication, rateLimit.

## Installation and Getting Started
- run `eureka-server`
- run `mysql`，ensure that the database table of `iam_service` has been initialized
- Go to the project directory and run `mvn spring-boot:run`

## Dependencies
- `go-register-server`: Registration service
- `config-server`: Configuration service
- `kafka`
- `mysql`：`iam_service` database

## Links

* [Change Log](./CHANGELOG.zh-CN.md)

## Reporting Issues
If you find any shortcomings or bugs, please describe them in the [issue](https://github.com/choerodon/choerodon/issues/new?template=issue_template.md).

## How to Contribute
Pull requests are welcome! [Follow](https://github.com/choerodon/choerodon/blob/master/CONTRIBUTING.md) to know for more information on how to contribute.

## Note
- Need to cooperate with `api-gateway` to complete the gateway functions such as authentication, traffic restriction.