Files
goma-gateway/docs/middleware/access.md

57 lines
1.0 KiB
Markdown
Raw Normal View History

2024-11-09 15:06:09 +01:00
---
title: Access
layout: default
parent: Middleware
nav_order: 2
---
# Access Middleware
Access middleware prevents access to a route or specific route path.
Example of access middleware
```yaml
# The server will return 403
- name: api-forbidden-paths
type: access
## prevents access paths
paths:
- /swagger-ui/*
- /v2/swagger-ui/*
- /api-docs/*
- /internal/*
- /actuator/*
```
### Apply access middleware on the route
```yaml
routes:
2024-11-10 08:15:47 +01:00
- path: /protected
2024-11-20 07:57:15 +01:00
name: protected
2024-11-09 15:06:09 +01:00
rewrite: /
destination: 'https://example.com'
methods: [POST, PUT, GET]
healthCheck:
cors: {}
middlewares:
- api-forbidden-paths
```
## Advanced Kubernetes deployment
```yaml
apiVersion: gomaproj.github.io/v1beta1
kind: Middleware
metadata:
name: access-middleware-sample
spec:
type: access
## prevents access paths
paths:
- /swagger-ui/*
- /v2/swagger-ui/*
- /api-docs/*
- /internal/*
- /actuator/*
2024-11-09 15:06:09 +01:00
```