https://github.com/connected-web/template-api

A customisable Template API built ontop of AWS API Gateway, AWS Lambda, and OpenAPI Specs
https://github.com/connected-web/template-api

Last synced: 4 months ago
JSON representation

A customisable Template API built ontop of AWS API Gateway, AWS Lambda, and OpenAPI Specs

• Host: GitHub
• URL: https://github.com/connected-web/template-api
• Owner: connected-web
• License: other
• Created: 2023-09-04T18:34:56.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-09-20T20:41:45.000Z (9 months ago)
• Last Synced: 2025-09-20T21:27:27.273Z (9 months ago)
• Language: TypeScript
• Size: 349 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Template API

A template for building highly scalable serverless APIs using AWS Lambda, API Gateway, and Amazon S3.

## Features

- 🌐 AWS API Gateway

- 🚀 Individual AWS Lambda endpoints (TypeScript)

- 📖 Self-documented with OpenAPI 3.0 spec generated by the API Gateway itself

- 🔒 Custom Hosted Zone with SSL certificate

- 🔑 SSO Authorization using AWS Cognito as a shared Auth service

- 🔐 Deployed via Github Actions using preconfigured OIDC relationship

## Deployment Summary

Template API - https://github.com/connected-web/template-api

Registered URL: https://template-api.dev.connected-web.services

### Endpoints

| Operation ID | HTTP Method | Path |

| --- | --- | --- |

| getStatus | GET | /status |

| getOpenAPISpec | GET | /openapi |

## Contributing

The API Template project is open for contributions. Please refer to the [Contributing Guidelines](CONTRIBUTING.md) for more information.

Happy coding! 🚀

## License Information

This project is licensed under the ISC License. See the [LICENSE](LICENSE.md) file for more information.