Swagger-like Developer Portal for Frappe
​
One thing that always frustrated me while developing in Frappe/ERPNext was API discovery.
Need to call a whitelisted method?
Search through source code
Figure out the full module path
Guess parameter names
Check if it expects GET or POST
Open multiple tabs to inspect DocTypes and child tables
So I built frappe_doc.
It's a Frappe app that automatically scans all installed apps and generates a live developer portal from your codebase.
Features
✅ Discover all @frappe.whitelist() APIs automatically
✅ Parse Python type hints and Google-style docstrings
✅ Search APIs by app, module, route, arguments, DocType, etc.
✅ Generate ready-to-copy frappe.call() and curl examples
✅ "Try It Out" functionality to execute API calls directly from the UI
✅ Explore DocType schemas with expandable child-table trees
✅ AST-based scanning (doesn't import or execute your code)
✅ Works with custom apps and ERPNext out of the box
Example
Instead of searching through code to find:
@frappe.whitelist() def apply_for_leave(...): ...
frappe_doc automatically generates:
API route
Parameter documentation
Return information
Example requests/responses
Interactive testing form
Frappe JS snippet
cURL snippet
DocType Explorer
One feature I'm particularly happy with:
Child tables are displayed as expandable trees, so instead of jumping between multiple DocTypes, you can inspect the entire document structure in one place.
Example:
Sales Order └── Items ├── item_code ├── qty ├── rate └── warehouse
Why AST?
The scanner uses Python's ast module rather than importing modules, which means:
No code execution
Safe on production servers
No side effects during scanning
Looking for feedback
Would this be useful in your workflow?
I'm interested in hearing:
Features you'd like to see
Limitations you encounter with Frappe APIs today
Whether you'd use something like this in production
GitHub: https://github.com/raisulislam0/frappe\_doc
Feedback and contributions are welcome!