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.4.0 (2019-01-03)
Added
CrudResource.execute(name, kwarg) decorator to define Service on:
collection_path/execute/name: validator on the body
path/execute/name: validator on the path and the body
@resource(collection_path='/foo', path='/foo/{bar}') class MyResource(CrudResource): @CrudResource.service('print', collection=True) def plop(self): # /foo/execute/print # verb : POST (default), GET, PUT, PATCH, DELETE, ... # schema optional # query = self.get_querystring('rest action given to get_model') # body = self.body ... @CrudResource.service('print') def otherplop(self): # /foo/{bar}/execute/print # verb : POST (default), GET, PUT, PATCH, DELETE, ... # schema optional for body, pathschema for path # body = self.body ...
Collection views to update and delete collection defined by querystring:
collection_put
collection_patch
collection_delete
Refactored
If a request.error is found during the execution of a view in the crud resource, then a registry.rollback will be done
Collection post is waiting a list of dict, Now it is possible to create more than one entry
0.3.0 (2018-12-07)
Removed
Compatibility with python 3.3
Fixed
QueryString filters and tags are executed only one time by query
in the context manager to save the error, the registry is now rollbacked
Refactored
The error field is now the key of the errors description dict (All validation errors messages are now dict)
0.2.1 (2018-10-06)
Added
MANIFEST.in file
Removed
VERSION file
0.2.0 (2018-10-01)
Added
context key in querystring. The goal is to add some informations to help custom filter and tag to build their query
Refactored
Now the querystring desarializer use regex to get the informations
0.1.0 (2018-09-26)
Added
CRUDResource class to define REST api
service behaviours
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 anyblok_pyramid_rest_api-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70047d9d0e2fcd104d470ac8509164c9f26ec742fd98ec646f52ad45e743a082 |
|
MD5 | a0e20c8735f13de5fa1452e953b68d44 |
|
BLAKE2b-256 | fbacb2622367e502b62771aa80e3e9b2e823834c258fb60ec9a1d397a0220c4f |
Hashes for anyblok_pyramid_rest_api-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 06754e1e4b64625cc224bff6433ac4533bf4330a7c9000426f55480ef7b5235f |
|
MD5 | 711358f64a893e88922dc171af56b549 |
|
BLAKE2b-256 | a5ec61a1babfbb865f2a17e695f5529570e69cf25a55f9eba92db669951c6144 |