This document discusses building a REST API with Pyramid. It covers setting up routes and views to handle GET, PUT, DELETE requests. It also discusses adding validation with Colander, authentication, and enabling CORS to allow requests from other origins. The REST API is built to provide autocomplete suggestions from a storage backend and allow adding, deleting, and validating item data.

1. REST w Pyramidzie
Łukasz Oleś

3. Prostota
Minimalizm
Dokumentacja
Szybkość
Stabilność

4. Działa na:
●Python 2.6 – 3.3
●PyPy
●Jython
●GAE

5. REST
http://autouzupelnij.pl
GET
http://api.autouzupelnij.pl/v1/public/city?term=gli

6. REST
(…)/public/city?term=gli
Nazwa konta

7. REST
(…)/public/city?term=gli
Nazwa konta Kontener

8. REST
(…)/public/city?term=gli
Nazwa konta Kontener Zapytanie

9. Nowy projekt
pcreate -t starter api
api
development.ini
setup.py
api
__init__.py
views.py

10. Plik api/__init__.py
from pyramid.config import Configurator
def main(global_config, **settings):
config = Configurator(settings=settings)
config.add_route('completion',
'/v1/{account}/{container}')
config.scan()
return config.make_wsgi_app()
pserve development.ini

11. Plik api/views.py
from pyramid.view import view_config
@view_config(route_name='completion',
renderer='json',
request_method='GET')
def completion(request):
account = request.matchdict['account']
container = request.matchdict['container']
query = request.params.get('term', u'')
storage = get_storage(account)
offers = storage.suggest(container, query))
return offers

12. Plik api/views.py
@view_config(route_name='completion',
renderer='json',
request_method='DELETE',
permission='edit')
def delete_container(request):
container = request.matchdict['container']
account = request.matchdict['account']
storage = get_storage( account)
storage.delete_container(container)

13. Nowy element
Plik api/__init__.py
config.add_route('items',
'/v1/{account}/{container}/{item}')

14. Plik api/views.py
@view_config(route_name='items',
renderer='json',
request_method='PUT',
permission='edit')
def add_item(request):
container = request.matchdict['container']
account = request.matchdict['account']
item = request.matchdict['item']
storage = get_storage(account)
storage.store_item(container, item)

15. Walidacja - dodatkowe dane
{
”population” : 20000,
”province” : ”slaskie”
}

16. Colander
http://docs.pylonsproject.org/projects/colander
from colander import MappingSchema,
SchemaNode, Int, String
class City(MappingSchema):
province = SchemaNode(String())
population = SchemaNode(Int())

17. Plik api/views.py
@view_config(route_name='items',
renderer='json',
request_method='PUT',
permission='edit')
def add_item(request):
container = request.matchdict['container']
account = request.matchdict['account']
item = request.matchdict['item']
city = City()
data = city.deserialize(request.json_body)
storage = get_storage(account)
storage.store_item(container, item, data)

18. @view_config(context=colander.Invalid)
def failed_valdation(exc, request):
err = json.dumps(exc.asdict())
return HTTPBadRequest(err)

19. Autoryzacja
http://docs.pylonsproject.org/projects/pyramid/en/
latest/tutorials/wiki2/authorization.html
https://ziggurat-foundations.readthedocs.org

20. Plik api/__init__.py
from api.auth import RootFactory, auth_check
def main(global_config, **settings):
config = Configurator(settings=settings,
root_factory=RootFactory,
authentication_policy=
AuthenticationPolicy(auth_check))

21. COSR – poziom zaawansowany
http://en.wikipedia.org/wiki/Cross-origin_resource_sharing
JavaScript Ajax
http://autouzupelnij.pl -> http://api.autouzupelnij.pl

22. COSR – poziom zaawansowany
Access-Control-Allow-Origin: http://autouzupelnij.pl
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET
Access-Control-Allow-Headers: Content-Type

23. COSR – poziom zaawansowany
Plik api/__init__.py
from pyramid.events import subscriber,
NewResponse
@subscriber(NewResponse)
def add_access_list(event):
event.response.headerlist.append(
('Access-Control-Allow-Origin', '*'))

24. Co dalej?
Cornice
http://cornice.readthedocs.org/

25. Pytania
Łukasz Oleś
lukaszoles@gmail.com

26. Dziękuję
Łukasz Oleś
lukaszoles@gmail.com