This project provides a middleware for Falcon Web Framework that will render the response in an HTML form for documentation purpose. It uses the docstring from the Resource object and all the supported HTTP methods for the resource.
It is inspired by Django Rest Framework’s Browsable API and is written using jinja2 templating language.
Installing
This project is currently in early stages of development. Once it is stable enough to be used by other projects, it will be provided via PyPI.
pip install git+https://github.com/maxking/falcon-api-browse
Using
Since this is a middleware for Falcon, you can use it by passing an initialized instance during Falcon App creation.
from falcon import App from falcon_api_browse import HTMLResponseMiddleware app = App(middleware=HTMLResponseMiddleware())
Examples
There are some runnable examples in examples/ directory.
LICENSE
This project and contents of this repo are licensed under Apache 2.0 License.
1 maintainer
Release files for falcon-api-browse 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| falcon_api_browse-0.1.1.tar.gz | 6.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| falcon_api_browse-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 15.0 kB
Release files / falcon_api_browse-0.1.1.tar.gz
| Download URL | falcon_api_browse-0.1.1.tar.gz |
|---|---|
| Size | 6.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3e8589ccaa0a5d5a2380ae020696be7fa8e267d3893a6be446f53b9315b3b91c
|
|
BLAKE2b-256 checksum How to use checksums |
b58f8986f94fbe4cd73ed746177e94c3c7b77ebd0683259f98c4c918afe74105
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.1 CPython/3.11.4
|
Release files / falcon_api_browse-0.1.1-py3-none-any.whl
| Download URL | falcon_api_browse-0.1.1-py3-none-any.whl |
|---|---|
| Size | 8.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ac84a98929abc2ac58cc3a2f9ee2c243437cab3a96f5aa72daba6d30d1252e53
|
|
BLAKE2b-256 checksum How to use checksums |
69063f42e582e80d5f4eabdf2782b7bf58928187fc17e8b569412a44d9905e99
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.1 CPython/3.11.4
|
