Build APIs for Frappe with the simplicity of FastAPI!
⚠️ Alert: Beta Version
This project is currently in beta and not yet ready for production use. Expect changes and improvements as we work towards a stable release.
Despite Frappe >= 15.0.0 pushing towards using type hints for API development and enhancing frappe.whitelist()
, I'd like to take it a step further. This project aims to:
And honestly? Why not? Sometimes you just want to build something cool, even if it might be a bit unnecessary. Who knows, it might just make Frappe developers' lives a little easier (or at least more FastAPI-ish). I'm doing it for the love of coding, and of course, for learning. If it helps someone along the way, that's a bonus!
app.get(...)
methodapp.post(...)
methodapp.put(...)
methodapp.patch(...)
methodapp.delete(...)
methodAutomatic query parameter parsing/conversion based on type hints
Required query parameters needy: str
Optional query parameters with default values skip: int = 0
Optional query parameters without default values limit: Union[int, None] = None
Automatic Documentation generation for query parameters
Enum support for query parameters path parameters - predefined values
Additional information and validation for query parameters
min_length
max_length
regex pattern
gt
ge
lt
le
title
description
deprecated
to be continued...
frappe.whitelist()
functionality