agbridge

visiting_blue_modestine

Securely forward requests to private AWS API gateways with ease.

0likes0comments

Visit project 0

Project details

About this project

agbridge is a lightweight CLI tool that acts as a local proxy for private AWS API Gateways, allowing secure HTTP request forwarding to non-public endpoints. Ideal for developers, it streamlines testing, debugging, and integration workflows, enabling interaction with internal microservices without complex setups.

agbridge is a lightweight command-line interface (CLI) tool that serves as a secure local proxy for forwarding requests to private AWS API Gateways. This tool enables developers to interact with internal services without exposing those APIs to the public internet or the complexities of VPNs and tunnels.

Designed specifically for testing, debugging, and automation, agbridge streamlines integration with private AWS services, making it ideal for workflows involving internal microservices. Key features of this tool include:

Key Features

🔒 Secure Access: Provides a secure method to access private API Gateways without public exposure.
🧪 Simplified Testing: Effectively facilitates testing and integration from local development environments or CI/CD pipelines.
⚙️ Flexible Configuration: Supports configuration via CLI flags or a YAML configuration file, catering to various user preferences.
🌐 Multiple API Gateways: Capable of managing multiple API Gateway definitions simultaneously for enhanced workflow efficiency.
🐳 Docker Compatibility: Ready for use in ephemeral or automated environments, making it versatile for various deployment scenarios.
🔄 Dynamic URL Matching: Supports advanced URL pattern matching, such as /blogs/{slug}/comment/{id}.
🎯 Custom Stage Support: Allows users to optionally select custom API Gateway stages with the --stage-name flag.

agbridge is the ideal solution for developers working with microservices, automating tests, or debugging internal APIs, providing a safe and user-friendly avenue to access private AWS resources.

Usage Examples

To initiate agbridge, use the following command structure:

agbridge [flags]

Flags

Flag	Description	Default
`--version`	Displays the application version and exits.
`--config`	Specifies the path to a configuration file (cannot be used with `--profile-name`, `--rest-api-id`, `--region` or `--stage-name`).
`--profile-name`	Specifies the profile name (requires `--rest-api-id` and `--region` to be specified).
`--rest-api-id`	Specifies the Rest API ID (required if `--config` is not provided).
`--region`	Specifies the AWS region to use with `--profile-name` and `--rest-api-id`.
`--stage-name`	Specifies the stage name to use with `--profile-name` and `--rest-api-id` and `--region`.
`--log-level`	Sets the log verbosity level. Options: `debug`, `info`, `warn`, `error`, `fatal`.	`info`
`--listen-address`	Address where the proxy server will listen for incoming requests.	`:8080`

Example Usages

Specify API Gateway with Profile:

agbridge --profile-name=myprofile --rest-api-id=12345

Load a Specific Configuration File:

agbridge --config=config.yaml

Configuration File Example:

gateways:
  - rest_api_id: xyz789ghi0
    profile_name: abc123def4
    region: eu-west-1

  - rest_api_id: 789ghi0xyz
    profile_name: my-aws-profile
    region: eu-east-1
    stage_name: prod

Change Listen Address:

agbridge --listen-address=:9090

agbridge brings efficiency and security to developers engaging with AWS's private APIs while enhancing the overall development experience.