joshua-light / chalice-restful Goto Github PK

Acceptance Criteria

• The project is built and tested on PRs.
• The project is built, tested and published after each successful push to master branch.

Requirements

• GitHub Actions should be used as a CI/CD server.
• pytest should be used as a test runner.

Motivation

Initial project structure will help future development of the features.

Acceptance Criteria

• The project is an empty Python package.
• It's ready to be published to the PyPi.

Requirements

• There should be one fake unit-test, that will be discoverable by pytest.

As an API developer, I want to define my endpoints using object-oriented style.

Motivation

Chalice uses a plain functions approach, where each endpoint is defined by a separate function decorated with the route decorator. For example:

app = Chalice(...)

@app.route('/a')
def a(): ...

@app.route('/b')
def b(): ...

@app.route('/c')
def c(): ...

When there are a lot of endpoints, related to different resources, we need to group functions together, and this in fact is a motivation for the Resource concept.

API

The API will be similar to flask-restful one.

@route('/v1/items')
class Items(Resource):
    def get(): ...
    def post(): ...

@route('/v1/items/{item})
class Item(Resource):
    def get(item: str): ...
    def patch(item: str): ...
    def delete(item: str): ...

app = Chalice(...)
api = Api(app)
api.add_resource(Items)
api.add_resource(Item)

Acceptance Criteria

• I can define grouped endpoints using Resource class.
• I can require API keys for any endpoint.
• I can enable/disable CORS for any endpoint.
• I can add an authorizer to any endpoint.

Requirements

• Code should be tested.
• Code should be documented.
• Tutorial should be added to the 'README' file.