Python Rest Api Framework
latest
  • What is Python REST API Framework
  • Tutorial: building an adressebook API
    • First Step Building a user endpoint
    • Playing with the newly created endpoint
    • Adding validators to your DataStore
    • Show data to users
    • Working with Pagination
    • Loading multiple endpoint
    • Linking ressource together
    • Representing relations
    • Authentication and Authorization: Protecting your API
    • Rate Limiting your endpoints
    • Implementing Partial Response
    • The Whole Application
  • REST API Framework API references
Python Rest Api Framework
  • Docs »
  • Tutorial: building an adressebook API
  • Edit on GitHub

Tutorial: building an adressebook APIΒΆ

  • First Step Building a user endpoint
    • Define a model
    • Chose a DataStore
    • Chose a view
    • Create The user endpoint
    • Summary
  • Playing with the newly created endpoint
    • Create a user
    • List and Get
    • Delete a user
    • Update a User
    • Filtering
    • Error handling
    • Autodocumentation
  • Adding validators to your DataStore
    • UniqueTogether
  • Show data to users
    • Define a formater function
    • Make things generics
  • Working with Pagination
    • Creating fixtures
    • Pagination
    • Browsering Through Paginated objects
    • Pagination and Filters
  • Loading multiple endpoint
    • Define a new model
    • Inherite from previous apps
    • Add the app to the dispatcher
    • Check that everything work
  • Linking ressource together
    • Adding an adress
    • Create a user linked to an address
    • Retreive the adress of a user
    • Retreive users from an adress
  • Representing relations
    • Representiing the relation on the user side
    • Check the formater
    • Formating data for the system
    • Check the Controller translation
  • Authentication and Authorization: Protecting your API
    • Authentication
    • Define a backend
    • Instanciate the Authentication backend
    • Instanciate the Authorization backend
    • Testing Authentication and Authorization Backend
  • Rate Limiting your endpoints
    • Create a datastore for rate-limit:
    • Add Rate-limit to your API
    • Test!
  • Implementing Partial Response
    • Test the Partial
  • The Whole Application
Next Previous

© Copyright 2013, Yohann Gabory. Revision 971f722f.

Built with Sphinx using a theme provided by Read the Docs.