Tools to build rest api's
Project description
Anyblok Pyramid Rest Api
The main idea is to provide facilities for building restful api that interacts with AnyBlok models through a CRUD like pattern.
As dependecy, it use Cornice for its validators and schema abilities and Marshmallow for schema definition, serialization and deserialization (we have since split this work to AnyBlok_Marshmallow).
Free software: Mozilla Public License Version 2.0
Documentation: https://anyblok-pyramid-rest-api.readthedocs.io
Features
Incoming request validation through schema (validation before database query and ability to validate several parts of the request object)
CRUD queries always with request.validated data
Data deserialization for response through schema
Easy CRUD resource declaration (map a model on an endpoint)
Automatic schema generation based on models introspection
Advanced collection filtering, ordering, paging (querystring validation through schema)
Todo
Helpers for JsonSchema or Swagger
Advanced introspection for api documentation generation
Request lifecyle
incoming request
-> validators -> deserializer (json to dict) -> schema load -> request.validated -> request.errors
request.validated
-> crud -> resulting records -> deserializer (records to schema dump) -> serializer (default pyramid / cornice dict to json serializer) -> response
Credits
Change Log
All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
0.1.0 (2018-09-26)
Added
CRUDResource class to define REST api
service behaviours
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 anyblok_pyramid_rest_api-0.1.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 57a5353443bdbd95f2ec5d4248ad41abf9cfad4aaa72ecf65c29722cb9fb6222 |
|
| MD5 | 944a274dcf28442422bd04b64c6f6c91 |
|
| BLAKE2b-256 | 55515f842d3745c545242be069f90de3108abf8ad52ef758b7c0877c0dcffaba |
Hashes for anyblok_pyramid_rest_api-0.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5cbfce78e6df8f549b0a83e68fdb7b5ce3543eb143423b55d093ec3dec40e5e3 |
|
| MD5 | 7bcebcbcd71aa5e88b2c508d09049415 |
|
| BLAKE2b-256 | e64a900e1a17f2b22347901341565f3463a323d7e1f6a6125196dfbd0e455eb9 |
