Cookiecutter API

This is a modern 🍪 Cookiecutter template to create REST APIs for multiple cloud platforms in multiple languages. This template supports the multiple cloud platforms and languages.

🧪 Usage

Install Cookiecutter using pip package manager:

# pipx is strongly recommended.
pipx install cookiecutter

# If pipx is not an option,
# you can install Cookiecutter in your Python user directory.
python -m pip install --user cookiecutter

To create a Cookiecutter API project, run the following for each implemented template.

# Create using the GH CLI
cookiecutter gh:Code-and-Sorts/cookiecutter-api/{LANGUAGE_OPTION}

# Create using the GH URL
cookiecutter https://github.com/Code-and-Sorts/cookiecutter-api.git --directory {LANGUAGE_OPTION}

Follow the prompts and answer them with your own desired options.

🌟 Supported Templates

	Azure	AWS	GCP
	Function App	Lambda	Cloud Function
	✅	📋	✅
	✅	📋	📋
	✅	📋	📋
	📋	📋	📋

---

Note

Each project follows the controller-service-repository pattern.

🎯 Examples

Python

• Function App Example

Typescript

• Function App Example

Dotnet

• Function App Example

📚 Resources

Below is a list of resources and documentation for the types of SDKs and frameworks used in the various Cookiecutter APIs.

Python

• Poetry for dependency management
• pytest and codecov for testing
• pydantic for schema validation

Typescript NodeJS

• Yarn for dependency management
• Jest for testing
• Zod for schema validtion

Dotnet

• Nuget for dependency management
• xUnit for testing
• FluentValidation for schema validtion

Azure

• Azure Function Apps for hosting the APIs
• Cosmos DB for data storage

AWS

• Lambda docs for hosting the APIs
• DynamoDB for data storage

Google Cloud

• Cloud Functions for hosting the APIs
• Firestore for data storage

🙏🏻 Acknowledgements

Florian Maas' cookiecutter-poetry repository was a very helpful resource for building out this Cookiecutter template.