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

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

FastAPI interesting concepts.

An extension library for FastAPI framework

API written using Fast API to manage events and implement a leaderboard / badge system.

User authentication fastapi with python

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

Dead-simple mailer micro-service for static websites

Lazy package to start your project using FastAPI✨

Simple notes app backend using Python's FastAPI framework.

Twitter API monitor with fastAPI + MongoDB

A server hosts a FastAPI application and multiple clients can be connected to it via SocketIO.

An alternative implement of Imjad API | Imjad API 的开源替代

Docker Sample Project - FastAPI + NGINX

Regex Converter for Flask URL Routes

Instrument your FastAPI app

Keycloak integration for Python FastAPI

Adds simple SQLAlchemy support to FastAPI

Drop-in MessagePack support for ASGI applications and frameworks

Prometheus exporter for metrics from the MyAudi API

Restful Api developed with Flask using Prometheus and Grafana for monitoring and containerization with Docker :rocket:

A simple Blogging Backend app created with Fast API