apispec_openapi_spec_with_marshmallow_schema_registration.py

1from apispec import APISpec
2from apispec.ext.marshmallow import MarshmallowPlugin
3from marshmallow import Schema, fields
4
5# Create an APISpec
6spec = APISpec(
7    title="Gisty",
8    version="1.0.0",
9    openapi_version="3.0.2",
10    plugins=[MarshmallowPlugin()],
11)
12
13# Define objects
14class GistSchema(Schema):
15    id = fields.Int()
16    content = fields.Str()
17
18# Register entities and systems
19spec.components.schema("Gist", schema=GistSchema)
20
21# Add documentation for a view
22spec.path(
23    path="/gists/{gist_id}",
24    operations=dict(
25        get=dict(
26            responses={"200": {"content": {"application/json": {"schema": "Gist"}}}}
27        )
28    ),
29)
30
31# Export to YAML
32# print(spec.to_yaml())
33
34# Export to dict
35# print(spec.to_dict())