https://github.com/maxking/falcon-api-browse
Browse JSON API in a HTML interface.
https://github.com/maxking/falcon-api-browse
falcon-framework falcon-middleware
Last synced: 7 months ago
JSON representation
Browse JSON API in a HTML interface.
- Host: GitHub
- URL: https://github.com/maxking/falcon-api-browse
- Owner: maxking
- License: apache-2.0
- Created: 2022-03-13T23:09:32.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-02T05:16:35.000Z (over 2 years ago)
- Last Synced: 2025-05-26T07:25:44.569Z (8 months ago)
- Topics: falcon-framework, falcon-middleware
- Language: Python
- Homepage:
- Size: 39.1 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
=================
Falcon API Browse
=================
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 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.