kushal-ti/chalice-spec

Chalice x APISpec x Pydantic plug-ins

chalice-spec

Chalice × APISpec × Pydantic plug-ins

Combines the power of Chalice, APISpec, and Pydantic to make AWS Chalice apps easily documented

Installation

First, add chalice-spec:

poetry add chalice_spec

We consider Chalice, APISpec, and Pydantic "peer dependencies." We only include them as dev dependencies in our codebase, and you may need to install them in yours if you haven't already.

poetry add chalice apispec pydantic

Setup

chalice-spec provides a subclass of the main Chalice class, called ChaliceWithSpec. Here is an example of how to get started:

Before:

from chalice import Chalice

app = Chalice(app_name="hello_world")

After:

from chalice_spec import ChaliceWithSpec, PydanticPlugin
from apispec import APISpec

spec = APISpec(...,
               plugins=[PydanticPlugin()])

app = ChaliceWithSpec(app_name="hello_world", spec=spec)

If you use

ChaliceWithSpec(..., generate_default_docs=True)

the plugin will generate empty docs (with empty request and response schemas) for every endpoint that you've defined in your app. This can be useful as a starting point / overview while developing.

Usage

To document your API, use your existing Pydantic models and add kwargs to Chalice decorators.

Before:

@app.route('/', methods=["POST"])
def example():
    body = MySchema.parse_obj(app.current_request.json_body)

After:

@app.route('/', methods=["POST"], docs=Docs(
    post=Operation(request=MySchema)
))
def example():
    body = MySchema.parse_obj(app.current_request.json_body)

If you have multiple methods supported, you may have something like:

@app.route('/', methods=["POST", "PUT"],
           docs=Docs(
               post=Operation(request=MyCreateSchema, response=MyReadSchema),
               put=Operation(request=MyEditSchema, response=MyReadSchema)
           )
def example():
    # code goes here
    pass

Auto-Generation

Default Empty Docs

If you use:

ChalicePlugin(generate_default_docs=True)

the plugin will generate empty docs (with empty request and response schemas) for every endpoint that you've defined in your app. This can be useful as a starting point / overview while developing.

Path Parameters

These are inferred from the path itself. Any identifiers inside curly braces in a path is added as a string path parameter for that path. e.g. for the path /users/{id}/friends/{f_id}, the path parameters id and f_id will be added to the spec.

To disable this behaviour, define your own parameters or set them to an empty list:

Operation(request=MySchema, response=MyOtherSchema, parameters=[])

Tags

Tags are used in things like Swagger to group endpoints into logical sets. If you don't supply any tags, chalice-spec will add a tag for each endpoint that is the first segment of the path. e.g. /users, /users/{id}/friends, and /users/{id}/posts will all be tagged with users.

To disable this behaviour, define tags in your operation (either with the tags you want, or an empty list):

Operation(request=MySchema, response=MyOtherSchema, tags=[])

Summary and Description

Endpoint summaries and descriptions are inferred from the route docstring. The first line of the docstring is used as the summary, and all other lines become the description:

@app.route('/users/{id}', methods=['GET'], docs=Docs(response=UserSchema))
def get_user(id):
    """
    Retrieve a user object.
    User's can't retrieve other users using this endpoint - only themselves.
    """

To disable this behaviour, you can define your own summary/description or set them to empty strings:

Operation(request=MySchema, response=MyOtherSchema, summary='', description='')

API

• TODO: this section coming soon!