Metadata-Version: 2.1
Name: dj-apibrowser
Version: 0.1.0
Summary: Generic GUI for any RESTful API
Home-page: https://gitlab.com/LEW21/dj-apibrowser
Author: Linus Lewandowski
Author-email: linus@lew21.net
License: UNKNOWN
Keywords: rest api browser
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Description-Content-Type: text/markdown

# Generic GUI for any RESTful API

See the demo at <https://apibrowser-demo.herokuapp.com/> ([source](https://gitlab.com/lew21/demoapi)).

`dj-apibrowser` itself is just a trivial middleware that serves [APIBrowser](https://gitlab.com/lew21/apibrowser), which is written in JS, and works purely in the web browser. It returns the APIBrowser HTML code whenever a web browser navigates to a page.

## Installation
```sh
pip install dj-apibrowser
```

### settings.py
* Add `dj_apibrowser.APIBrowserServerMiddleware` to the list of `MIDDLEWARE`s.
* If neccesary, specify on which endpoints should we serve APIBrowser. Default config means that this is disabled on paths starting from /admin/, and enabled on all other paths:
```
API_ENDPOINTS = [
    ('admin/', False),
    ('', True),
]
```


