Introduction

Get started with Serverless API Gateway: clone the repo, install dependencies, configure routes and JWT auth, then deploy to Cloudflare Workers in minutes.

To start using the Serverless API Gateway:

1. Clone the repository:

git clone https://github.com/irensaltali/serverlessapigateway.git

1. Install dependencies:

cd serverlessapigateway
npm install

1. Configure your routes, CORS settings, and JWT secrets within the provided configuration files.

2. Deploy your worker to Cloudflare using the command:

wrangler deploy

(For detailed setup and usage instructions, please see the Cloudflare Workers' documentation). You can also deploy via GitHub Actions for automated CI/CD.

Usage Guidelines

• Ensure that each section of the JSON is correctly formatted according to the schema.

• Modify the configuration to suit your application's requirements. See the Configuration Guide for a full reference of all available settings.

• The configuration should be loaded and parsed by your application at startup.

• Use canonical examples from serverlessapigateway/docs/config-examples as the source of truth for docs and onboarding.

• Review the cost breakdown to understand Cloudflare Workers pricing for your expected traffic.

Contributing

Your contributions are what make the Serverless API Gateway an even better API management solution! If you have suggestions for new features, notice a bug, or want to improve the code, please take the following steps:

1. Fork the repository.

2. Implement your changes on a new branch.

3. Submit a pull request with a clear description of your improvements.

Acknowledgments

A shoutout to the contributors, community members, and the maintainers of Cloudflare Workers for their support and inspiration in making this project a reality.

The Serverless API Gateway is not just another API tool; it's created by developers, for developers, with the vision of making API management a breeze. Let's build together.

Support

I'm always happy to help with any questions or concerns you may have. Feel free to reach out to me from on Twitter or LinkedIn.

If you need a more extensive support you can always book on Superpeer

Companies that use Serverless API Gateway

Let us know if you are using Serverless API Gateway and we can add your company here.\