falconry/falcon

Revamp things-advanced (WSGI/ASGI) examples

Open

#2309 opened on Aug 28, 2024

View on GitHub
 (11 comments) (1 reaction) (0 assignees)Python (9,293 stars) (925 forks)batch import
documentationgood first issuemaintenanceneeds contributor

Description

We ought to showcase media handling in these instead of manually wrangling (de-)serialization. It is fine to show what is possible, but the emphasis should still be on media.

Revise App vs API usage: Useful for debugging problems in your API; :arrow_right: Useful for debugging problems in your App;.

Also check what's going on with the missing Content-Length in the ASGI variant, it looks like the proposed middleware doesn't handle it particularly well.

Contributor guide

Tech stack
pythonrest api
Domain
backendapi
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonFalcon frameworkWSGI/ASGI basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the existing 'things advanced' example in the Falcon repository. Examine how media handling is currently implemented manually and identify gaps for showcasing the framework's built in media handling. Check the ASGI variant for the missing Content Length header issue mentioned in the issue body. Look at the comments on issue #2309 for any proposed approaches or discussions about the App vs API usage revision.