The library for writing RESTful APIs with sanic
Project description
sanic-restful-resources
Simple library for creating RESTful APIs with sanic
Features
- simplicity
- schematics integration
- exceptions handling
- unified response format
- 100% coverage
Usage
python3 -m pip install sanic-restful-resources
Example
users = [{'name': 'Michael'}, {'name': 'Ivan'}]
class UserPostSchema(Model):
name = StringType(required=True)
@resource('/users')
class Users:
async def get(self, request):
return users
@validate(user_data=UserPostSchema)
async def post(self, request, user_data):
users.append({'name': user_data.name})
return '', 204
More examples in this folder.
Guide
-
resource(uri='')
- return decorator for classes that will be considered RESTful resources. This decorator automatically extends HTTPMethodView (refer to sanic documentation for details). You can provide resource URI through decorator or by class attributeuri
. You can provide decorators for all the methods through class attributedecorators
.Examples of possible return values for handlers:
return "data", 200, {"X-Custom-Header": "Value"} return "data", 200 return "data" return {"arg": "val"} return ["val1", "val2"] return "", 201 return sanic.response.json # .text, .html, e.t.c.
-
Api(name='API', url_prefix)
- class for aggregating resources and registrating them in the sanic application. Internally it uses blueprints. Basic workflow:from sanic import Sanic from resources import User, Users app = Sanic() api = Api(url_prefix='/api/v1') api.add_resource(User) api.add_resource(Users) api.init_app(app) # ...
-
validate(**models)
- decorator for methods, that will validate incoming data with provided models from Schematics library. Successfully validated and parsed models will be passed as keyword arguments to the handler method. If any model fails to validate - handler will not be called. -
error(description=None, details=None, status=400, **kwargs
- method for returning errors from handlers. -
collect_args(request)
- method for getting data from all possible sources of data in the request.
Project details
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 sanic_restful_resources-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52d912ee46e00ead072920e29891e702e1c16c75720a18fee810e7a1ef754fb4 |
|
MD5 | dfd5c1fdff4a5bf8ae4042535a27c4c4 |
|
BLAKE2b-256 | d0c593f8fac9fea374075a4e69137891db6f1569c7c85b0b8c523f6c0101d51a |
Hashes for sanic_restful_resources-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 864c7c92a923153f1747236530ec552bc347bca4db8bde61ad5f94809d37bc14 |
|
MD5 | c41b1f0ff06c5d3f0518db5940149872 |
|
BLAKE2b-256 | e057e53826f3a7ac9a0061c29a7d345d1bce904f997a68beca5de187fb2bdf19 |