Web Route Analyser¶
Overview¶
Detects HTTP route changes in Flask or FastAPI apps.
Dependencies¶
Flask
orFastAPI
Framework providing HTTP routes
Enable/Disable¶
bumpwright --enable-analyser web_routes
bumpwright --disable-analyser web_routes
[analysers]
web_routes = true # set to false to disable
See also
For configuration options, see concepts/configuration#analysers.
Severity Rules¶
Change |
Bump |
---|---|
Added route |
|
Removed route |
|
Added optional param |
|
Added required param |
|
Removed optional param |
|
Removed required param |
|
Param became optional |
|
Param became required |
|
Example¶
@@
@app.get("/users/{user_id}")
-def get_user(user_id: int):
- ...
+def get_user(user_id: int, verbose: bool = False):
+ ...
- [MINOR] GET /users/{user_id}: Added optional param 'verbose'