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

A dynamic FastAPI router that automatically creates CRUD routes for your models

⚡ Create CRUD routes with lighting speed ⚡ A dynamic FastAPI router that automatically creates CRUD routes for your models

950 Jan 08, 2023

Redis-based rate-limiting for FastAPI

6 Nov 14, 2022

A minimal Streamlit app showing how to launch and stop a FastAPI process on demand

Simple Streamlit + FastAPI Integration A minimal Streamlit app showing how to launch and stop a FastAPI process on demand. The FastAPI /run route simu

18 Jan 02, 2023

This project shows how to serve an ONNX-optimized image classification model as a web service with FastAPI, Docker, and Kubernetes.

Deploying ML models with FastAPI, Docker, and Kubernetes By: Sayak Paul and Chansung Park This project shows how to serve an ONNX-optimized image clas

104 Dec 23, 2022

Keycloak integration for Python FastAPI

FastAPI Keycloak Integration Documentation Introduction Welcome to fastapi-keycloak. This projects goal is to ease the integration of Keycloak (OpenID

113 Dec 31, 2022

REST API with FastAPI and PostgreSQL

REST API with FastAPI and PostgreSQL To have the same data in db: create table CLIENT_DATA (id SERIAL PRIMARY KEY, fullname VARCHAR(50) NOT NULL,email

1 Nov 11, 2021

FastAPI CRUD template using Deta Base

Deta Base FastAPI CRUD FastAPI CRUD template using Deta Base Setup Install the requirements for the CRUD: pip3 install -r requirements.txt Add your D

2 Dec 15, 2021

Turns your Python functions into microservices with web API, interactive GUI, and more.

Instantly turn your Python functions into production-ready microservices. Deploy and access your services via HTTP API or interactive UI. Seamlessly export your services into portable, shareable, and

2.8k Jan 04, 2023

Qwerkey is a social media platform for connecting and learning more about mechanical keyboards built on React and Redux in the frontend and Flask in the backend on top of a PostgreSQL database.

Flask React Project This is the backend for the Flask React project. Getting started Clone this repository (only this branch) git clone https://github

22 Dec 20, 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

A dynamic FastAPI router that automatically creates CRUD routes for your models

Redis-based rate-limiting for FastAPI

A minimal Streamlit app showing how to launch and stop a FastAPI process on demand

This project shows how to serve an ONNX-optimized image classification model as a web service with FastAPI, Docker, and Kubernetes.

Keycloak integration for Python FastAPI

REST API with FastAPI and PostgreSQL

FastAPI CRUD template using Deta Base

Turns your Python functions into microservices with web API, interactive GUI, and more.

Qwerkey is a social media platform for connecting and learning more about mechanical keyboards built on React and Redux in the frontend and Flask in the backend on top of a PostgreSQL database.

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

Пример использования GraphQL Ariadne с FastAPI и сравнение его с GraphQL Graphene FastAPI

fastapi-admin2 is an upgraded fastapi-admin, that supports ORM dialects, true Dependency Injection and extendability

flask extension for integration with the awesome pydantic package

A FastAPI Middleware of joerick/pyinstrument to check your service performance.

Complete Fundamental to Expert Codes of FastAPI for creating API's

LuSyringe is a documentation injection tool for your classes when using Fast API

FastAPI IPyKernel Sandbox

Simple example of FastAPI + Celery + Triton for benchmarking

Flask + marshmallow for beautiful APIs

Regex Converter for Flask URL Routes