Skip to content

porthunt/aozora

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

aozora

Aozora allows you to create an API skeleton using API Gateway + Lambda functions using Serverless Framework.

It create a HTTP API on API Gateway + lambda functions for each endpoint.

Overview

./aozora.py --name my-api
cd my-api
npm i serverless --save-dev
npm i serverless-offline --save-dev
sls offline start --stage local

You can set up another location to create the directory using:

./aozora.py --name my-api --location ~/Coding

API folder structure:

my-api
├── README.md
├── .gitignore
├── .npmignore
├── Makefile
├── requirements.txt
├── requirements-dev.txt
├── serverless.yml
├── vars.yml
├── tests
|   └── ...
└── app
    ├── errors.py
    ├── settings.py
    ├── models
    |   └── response.py
    └── endpoints
        ├── __init__.py
        └── others.py

Some __init__.py were not included for easier readability.

Configuring API

After creating your API, you can modify stuff on serverless.yml. It's possible to modify the function timeouts, memory, permissions for the role, etc.

For references, please refer to the official serverless framework guide.

About

Set up an API on AWS running one command.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published