safrs : SqlAlchemy Flask-Restful Swagger2
Project description
Please check the GitHub Readme for documentation.
Overview
SAFRS is an acronym for SqlAlchemy Flask-Restful Swagger. The purpose of this framework is to help python developers create a self-documenting JSON API for sqlalchemy database objects and relationships. These objects can be serialized to JSON and can be created, retrieved, updated and deleted through the JSON API. Optionally, custom resource object methods can be exposed and invoked using JSON. Class and method descriptions and examples can be provided in yaml syntax in the code comments. The description is parsed and shown in the swagger web interface.
The result is an easy-to-use swagger/OpenAPI and JSON:API compliant API specification.
Installation
SAFRS can be installed as a pip package or by downloading the latest version from github, for example:
git clone https://github.com/thomaxxl/safrs
cd safrs
pip3 install -r requirements.txt --user
python3 setup.py install --userThe examples can then be started with
python3 examples/demo_relationship.py "your-interface-ip"Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file safrs-2.12.0.tar.gz.
File metadata
- Download URL: safrs-2.12.0.tar.gz
- Upload date:
- Size: 69.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
585a9731752f39c120abfd8c0391a502e7cc428290fc5d291331039b300c772e
|
|
| MD5 |
70a4e8d19204eceb6589d4aa45c799cc
|
|
| BLAKE2b-256 |
af3b10d7741878bc158f01b777a05d163c8d239834e0ab2d5b914c915493293d
|
