Browse JSON API in a HTML interface.

Last update: Mar 16, 2022

Overview

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 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.

Comments

JSON from `resp.media` is not recognized

It seems this only works as expected if JSON is rendered via resp.text; however, the most idiomatic and succinct way of writing a JSON API is by leveraging req.get_media() and resp.media.

Test case used:

import falcon
from falcon_api_browse import HTMLResponseMiddleware


class Hello:
    def on_get(self, req, resp):
        resp.media = {'message': 'Hello, World!', 'cool': True}


app = falcon.App(middleware=[HTMLResponseMiddleware()])
app.add_route('/hello', Hello())

enhancement

opened by vytas7 4

No module named `importlib_resources`

It seems that some dependencies are required, but not listed:

  File "/tmp/test.py", line 2, in <module>
    from falcon_api_browse import HTMLResponseMiddleware
  File "/tmp/venv/lib/python3.8/site-packages/falcon_api_browse/__init__.py", line 1, in <module>
    from falcon_api_browse.middleware import HTMLResponseMiddleware
  File "/tmp/venv/lib/python3.8/site-packages/falcon_api_browse/middleware.py", line 1, in <module>
    from falcon_api_browse.views import html_response
  File "/tmp/venv/lib/python3.8/site-packages/falcon_api_browse/views.py", line 4, in <module>
    from importlib_resources import files
ModuleNotFoundError: No module named 'importlib_resources'

bug

opened by vytas7 1

Add an explicit dependency on importlib-resources.

On newer version of Python, this is a stdlib package, but the API still differs in different version. Adding a dependeny on this makes it usable on all Python version while it handles noop operation on Python versions that have the same API as this package.

Fixes #4

opened by maxking 0
ASGI support

Since HTMLResponseMiddleware doesn't seem to perform any taxing I/O, one could implement ASGI support by simply wrapping the current logic via async def process_response_async(...).
enhancement

opened by vytas7 0
Add some CSS to the default template

The current default template is very vanilla, it could use some styling support with CSS. We could also urlize some of the urls, although it doesn't seem to work with the default urlize function for whatever reason (probably, because URLs are strings with "<url>" enclosing quotes that throws off their regex matcher.
enhancement help wanted

opened by maxking 0
Verify the response's content_type before assuming it is JSON

We currently assume that the response is JSON, but it can be anything like HTML, msgpack etc. We should not make this assumption and add some guard to verify the response's content_type.
enhancement help wanted good first issue

opened by maxking 0

Releases(0.1.0)

0.1.0(Mar 14, 2022)

This is a basic first release mostly meant to grab PyPI namespace. This is in alpha stage and is not considered stable for use.
Source code(tar.gz)
Source code(zip)

Owner

Abhilash Raj

GNU Mailman lead developer. @python core dev. I have code over at https://gitlab.com/maxking

GitHub Repository

Starlette middleware for Prerender

Prerender Python Starlette Starlette middleware for Prerender Documentation: https://BeeMyDesk.github.io/prerender-python-starlette/ Source Code: http

14 May 02, 2021

Dead simple CSRF security middleware for Starlette ⭐ and Fast API ⚡

csrf-starlette-fastapi Dead simple CSRF security middleware for Starlette ⭐ and Fast API ⚡ Will work with either a input type="hidden" field or ajax

9 Nov 20, 2022

Simple notes app backend using Python's FastAPI framework.

my-notes-app Simple notes app backend using Python's FastAPI framework. Route "/": User login (GET): return 200, list of all of their notes; User sign

2 Sep 17, 2022

A comprehensive CRUD API generator for SQLALchemy.

FastAPI Quick CRUD Introduction Advantage Constraint Getting started Installation Usage Design Path Parameter Query Parameter Request Body Upsert Intr

192 Jan 06, 2023

OpenAPI for Todolist RESTful API

swagger-client OpenAPI for Todolist RESTful API This Python package is automatically generated by the Swagger Codegen project: API version: 1 Package

1 Dec 19, 2021

Farlimit - FastAPI rate limit with python

FastAPIRateLimit Contributing is F&E (free&easy) Y Usage pip install farlimit N

27 Oct 06, 2022

Slack webhooks API served by FastAPI

Slackers Slack webhooks API served by FastAPI What is Slackers Slackers is a FastAPI implementation to handle Slack interactions and events. It serves

68 Jan 05, 2023

Beyonic API Python official client library simplified examples using Flask, Django and Fast API.

Beyonic API Python Examples. The beyonic APIs Doc Reference: https://apidocs.beyonic.com/ To start using the Beyonic API Python API, you need to start

46 Sep 01, 2022

Flask + marshmallow for beautiful APIs

Flask-Marshmallow Flask + marshmallow for beautiful APIs Flask-Marshmallow is a thin integration layer for Flask (a Python web framework) and marshmal

768 Dec 22, 2022

Reusable utilities for FastAPI

Reusable utilities for FastAPI Documentation: https://fastapi-utils.davidmontague.xyz Source Code: https://github.com/dmontagu/fastapi-utils FastAPI i

1.3k Jan 04, 2023

🚀 Cookiecutter Template for FastAPI + React Projects. Using PostgreSQL, SQLAlchemy, and Docker

FastAPI + React · A cookiecutter template for bootstrapping a FastAPI and React project using a modern stack. Features FastAPI (Python 3.8) JWT authen

1.4k Jan 02, 2023

Docker image with Uvicorn managed by Gunicorn for high-performance FastAPI web applications in Python 3.6 and above with performance auto-tuning. Optionally with Alpine Linux.

Supported tags and respective Dockerfile links python3.8, latest (Dockerfile) python3.7, (Dockerfile) python3.6 (Dockerfile) python3.8-slim (Dockerfil

2.1k Dec 31, 2022

Browse JSON API in a HTML interface.

Related tags

Overview

Falcon API Browse

Installing

Using

Examples

LICENSE

Comments

JSON from `resp.media` is not recognized

No module named `importlib_resources`

Add an explicit dependency on importlib-resources.

ASGI support

Add some CSS to the default template

Verify the response's content_type before assuming it is JSON

Releases(0.1.0)

0.1.0(Mar 14, 2022)

Owner

Abhilash Raj

Starlette middleware for Prerender

Dead simple CSRF security middleware for Starlette ⭐ and Fast API ⚡

Simple notes app backend using Python's FastAPI framework.

A comprehensive CRUD API generator for SQLALchemy.

OpenAPI for Todolist RESTful API

Farlimit - FastAPI rate limit with python

Slack webhooks API served by FastAPI

Beyonic API Python official client library simplified examples using Flask, Django and Fast API.

Flask + marshmallow for beautiful APIs

Reusable utilities for FastAPI

🚀 Cookiecutter Template for FastAPI + React Projects. Using PostgreSQL, SQLAlchemy, and Docker

Docker image with Uvicorn managed by Gunicorn for high-performance FastAPI web applications in Python 3.6 and above with performance auto-tuning. Optionally with Alpine Linux.

Mixer -- Is a fixtures replacement. Supported Django, Flask, SqlAlchemy and custom python objects.

A kedro-plugin to serve Kedro Pipelines as API

Prometheus integration for Starlette.

Keycloack plugin for FastApi.

FastAPI interesting concepts.

Fast, simple API for Apple firmwares.

Browse JSON API in a HTML interface.

FastAPI IPyKernel Sandbox