spec-first/connexion

RoutingMiddleware should sort paths

Open

#1,879 opened on Feb 13, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (4,346 stars) (738 forks)batch import
PR welcomeenhancementgood first issue

Description

Connexion middleware sorts all available APIs from most specific to least because of starlettte's routing behavior https://github.com/spec-first/connexion/blob/5d7eb0bdab9ed404e1d294dac6ed951af3be7952/connexion/middleware/main.py#L334

Similar sorting algorithms should be done within an api's routes in the RoutingMiddleware

Contributor guide

Tech stack
python
Domain
backendapi
Issue type
feature
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic PythonUnderstanding of routing in web frameworks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue points to the sorting logic in main.py at line 334. The needed change is to implement a similar sorting of routes within the RoutingMiddleware class. The contributor should study the existing sorting algorithm and replicate it for the middleware's routes. Check any existing tests for routing to ensure correctness.