Skip to content

Example docsadd anchor link in examples #2170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 24, 2025
Merged

Example docsadd anchor link in examples #2170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
493bc4d
add anchor link in examples
russelmrcl Sep 24, 2025
72a10f2
add anchor link in examples/graphql
russelmrcl Sep 24, 2025
da7ca43
edit heading in access-control-list
russelmrcl Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions distribution/examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Have **10 minutes** and want to solve a task with Membrane? These hands-on examples are ready to run and explore.

## [Deployment and Installation](deployment)
## [Deployment and Installation](deployment#deployment-and-installation)

* Docker
* As Windows service
Expand All @@ -12,7 +12,7 @@ Have **10 minutes** and want to solve a task with Membrane? These hands-on examp
* Deploy APIs from OpenAPI definitions
* Validate requests, responses, and security

## [API Traffic Routing](routing-traffic)
## [API Traffic Routing](routing-traffic#api-traffic-routing)

* Rewriting API URLs
* Shadow traffic to other environments (e.g., TEST)
Expand All @@ -21,13 +21,13 @@ Have **10 minutes** and want to solve a task with Membrane? These hands-on examp
* Internal routing
* Throttle API traffic

## [Scripting](scripting)
## [Scripting](scripting#scripting)

* Use Groovy and JavaScript for scripting

Samples of scripting with JSONPath, XPath and the expression language you can find in the [templating](templating) or [orchestration](orchestration) folders.
Samples of scripting with JSONPath, XPath and the expression language you can find in the [templating](templating#template---transforming-messages) or [orchestration](orchestration#orchestration) folders.

## [Security](security)
## [Security](security#samples-for-api-security-with-membrane-api-gateway)

* Authentication and authorization with JWT, OAuth2 and OIDC
* **API keys** and Basic Authentication
Expand All @@ -37,20 +37,20 @@ Samples of scripting with JSONPath, XPath and the expression language you can fi
* IP and host-based **Access Control Lists**
* Form login
* NTLM
* [Rate limiting](rate-limiting)
* [Rate limiting](rate-limiting#rate-limiter)

### [Message Validation](validation)
### [Message Validation](validation#message-validation)

* HTML-form validation
* JSON-Schema validation

## [Orchestration](orchestration)
## [Orchestration](orchestration#orchestration)

* Authentication with external APIs
* Samples for GET and POST callouts
* Use for-loops for multiple callouts

## [Extending Membrane](extending-membrane)
## [Extending Membrane](extending-membrane#configuration-and-extension-examples-for-membrane-api-gateway)

* Use `if` conditions to modify behavior
* Externalize configuration with **properties** and **environment variables**
Expand All @@ -62,21 +62,21 @@ Samples of scripting with JSONPath, XPath and the expression language you can fi



## [Message Transformation](message-transformation)
## [Message Transformation](message-transformation#message-transformation)

* Create dynamic API responses using [templates](templating) (JSON, XML, Text)
* Generic JSON to XML and XML to JSON
* Replacing with Regex
* Transformation with Javascript

## [Legacy Integration for XML and Web Services](web-services-soap)
## [Legacy Integration for XML and Web Services](web-services-soap#web-services-soap)

### [XML](xml)
### [XML](xml#xml)

* XML validation and XSLT transformation
* Create XML plugins with DOM or StAX

### [Web Services with SOAP](web-services-soap)
### [Web Services with SOAP](web-services-soap#web-services-soap)

* Validation of SOAP messages against WSDL
* REST to SOAP conversion and migration
Expand All @@ -87,24 +87,24 @@ Samples of scripting with JSONPath, XPath and the expression language you can fi

## Other Protocols

### [GraphQL](graphql)
### [GraphQL](graphql#graphql)

* Validate GraphQL requests

### [Web Sockets](websockets)
### [Web Sockets](websockets#websockets)

* STOMP over Websockets
* Writing own Web Sockets plugins

## Operation

### [YAML Configuration](yaml-configuration)
### [YAML Configuration](yaml-configuration#yaml-configuration)

### [Monitoring and Tracing](monitoring-tracing)
### [Monitoring and Tracing](monitoring-tracing#monitoring-tracing)

* OpenTelemetry & Prometheus

### [Logging](logging)
### [Logging](logging#logging-requests-and-responses)

* Access log
* Log into console, CSV or databases
Expand Down
1 change: 1 addition & 0 deletions distribution/examples/deployment/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Deployment and Installation
1 change: 1 addition & 0 deletions distribution/examples/graphql/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# GraphQL
1 change: 1 addition & 0 deletions distribution/examples/message-transformation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Message Transformation
1 change: 1 addition & 0 deletions distribution/examples/monitoring-tracing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Monitoring Tracing
1 change: 1 addition & 0 deletions distribution/examples/orchestration/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Orchestration
1 change: 1 addition & 0 deletions distribution/examples/routing-traffic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# API Traffic Routing
1 change: 1 addition & 0 deletions distribution/examples/scripting/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Scripting
2 changes: 1 addition & 1 deletion distribution/examples/security/access-control-list/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### ACCESS CONTROL INTERCEPTOR
# ACCESS CONTROL INTERCEPTOR

With the AccessControlInterceptor you can restrict access to services and resources.

Expand Down
1 change: 1 addition & 0 deletions distribution/examples/validation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Message Validation
1 change: 1 addition & 0 deletions distribution/examples/web-services-soap/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Web Services with SOAP
1 change: 1 addition & 0 deletions distribution/examples/websockets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Websockets
1 change: 1 addition & 0 deletions distribution/examples/xml/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# XML