apispec_marshmallow_openapi_schema_yaml_generation.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(required=True)
17
18# Register entities and paths
19spec.components.schema("Gist", schema=GistSchema)
20
21spec.path(
22    path="/gists/{gist_id}",
23    operations=dict(
24        get=dict(
25            responses={"200": {"content": {"application/json": {"schema": "Gist"}}}}
26        )
27    ),
28)
29
30# Export to YAML
31print(spec.to_yaml())