A Flask-based framework for easy REST API projects building.
Project description
Flask-RESTBuilder
Flask-RESTBuilder is a mircroframework based on Flask and some Flask’s extensions. It’s aimed to make it easier to build a RESTful API project in Flask.
Installing
Install and update by pip:
pip install flask_restbuilder
Example
About Project
Use command flask_restbuilder start to create a project:
path/to/project: flask_restbuilder start
What is your project's name? [myproject]: myproject
Where you want to create?(empty to current dir) [path/to/project]:
Your project's modules(use whitespace to split) [mymodule]: app1 app2
Need swagger support?(y/n) [y]:
Follow the guidance and finish the questions below, you will get a directory (The project directory is based on src mode):
myproject
├─ .gitignore
├─ CHANGES.rst
├─ README.rst
└─ src
└─ myproject
├─ config.py
├─ manage.py
├─ app
│ ├─ __init__.py
│ ├─ api
│ │ ├─ app1.py
│ │ ├─ app2.py
│ │ └─ __init__.py
│ ├─ app1
│ │ ├─ models.py
│ │ ├─ routes.py
│ │ └─ __init__.py
│ └─ app2
│ ├─ models.py
│ ├─ routes.py
│ └─ __init__.py
└─ extension
└─ mysql.py
About API
Create your API views like:
from flask_restbuilder import RESTful
class MyAPI(RESTful):
def __init__(self):
self.parser.add_argument('arg')
self.parse_arguments()
def get(self):
result = self.init_response(data=self.args)
return result
self.parser is an instance of flask_restful.reqparse.RequestParser, use add_argument the same way. Use self.parse_arguments to make self.args = self.parser.parse_args()
About Error
There some basic errors in flask_restbuilder.exceptions. Customize your exceptions from flask_restbuilder.BaseError:
from flask_restbuilder import BaseError
class MyError(BaseError):
code = 12345
message = 'my error message'
About Database
Flask_SQLAlchemy is equipped. You can see in extension/mysql.py and freely edit any basic options.
Thanks to
Project details
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
Built Distribution
Hashes for Flask_RESTBuilder-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a74e291faf051dd08f812983dc4e92b168bea2d6fd39d5a94da7e2c6e93524a |
|
MD5 | 1c2ebd61aac2dc109f4ad199c6ae44e8 |
|
BLAKE2b-256 | 0fdbc4ee87e1400d2acc9f895d563708558522e8cb076b96cf53bc9142a9e7e9 |