Skip to content

Commit

Permalink
[readme] add links to wiki pages
Browse files Browse the repository at this point in the history
  • Loading branch information
FrogDevelopper committed Aug 15, 2024
1 parent 83f8a55 commit 965aa28
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 37 deletions.
3 changes: 3 additions & 0 deletions micronaut-api-gateway-grpc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# gRPC API GATEWAY

more details in wiki page [api-gateway-grpc](https://github.com/FrogDevelopment/micronaut-api-gateway/wiki/api-gateway-grpc)
38 changes: 1 addition & 37 deletions micronaut-api-gateway-http/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,3 @@
# HTTP API GATEWAY

## Direct Gateway

Requests will be directly redirect to the Service set in the URI.
For example, given the configuration

```yaml
gateway:
direct: true
```
- `{host}/api/my-service/foo/bar` will be proxied to `{my-service-endpoint}/foo/bar`
- `{host}/api/my-service/my-endpoint` will be proxied to `{my-service-endpoint}/my-endpoint`

## Routed Gateway

Requests will be re-routed based on configured routes and context.
For example, given the configuration

```yaml
gateway:
direct: false
routes:
my-service:
service-id: my-service-id
mapping:
- route: foo-bar
context: /foo/bar
- route: my-endpoint
some-remote-application:
uri: https://example.com
mapping:
- route: example
```

- `{host}/api/foo-bar` will be proxied to `{service-endpoint}/foo/bar`
- `{host}/api/my-endpoint` will be proxied to `{service-endpoint}/my-endpoint`
- `{host}/api/example` will be proxied to `https://example.com`
more details in wiki page [api-gateway-http](https://github.com/FrogDevelopment/micronaut-api-gateway/wiki/api-gateway-http)

0 comments on commit 965aa28

Please sign in to comment.