marshmallow-code / marshmallow-code/flask-smorest

How to structure a real world application

Open
#38 11 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Python
Stars
717
Forks
77
Avg merge
7h 49m
Merged PRs (30d)
3

Description

Hi,

I believe that due to recent updates in both `apispec` and `marshmallow` my application started to throw warnings and exceptions (e.g., `marshmallow.exceptions.RegistryError`, `apispec.exceptions.DuplicateComponentNameError`) that were not happening a few weeks ago.

I couldn't came up with a minimal example to illustrate this yet. But I wonder if you could provide an example (beyond the basic "Petstore example" from the docs) of how to structure a more realistic application (like using the application factory pattern, splitting schemas and views in different modules, etc).

Regards,

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Petstore example in the documentation and the issue discussion about apispec and marshmallow warnings. The issue does not name files or tests, so first identify where the current example lives and what a realistic application structure should cover. Done means the documentation includes a working, maintainable example beyond Petstore.

Written by the indexing model from the issue text.

Assessment

Tech stack
flask, python
Domain
backend-api-design, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.