graceful

elegant Python REST toolkit built on top of falcon

Navigation

  • graceful
  • Graceful guide
    • Resources
    • Generic API resources
    • Parameters
    • Serializers and fields
    • Authentication and authorization
    • Working with resources
    • Content types
    • Documenting your API
  • API reference

Related Topics

  • Documentation overview
    • Previous: graceful
    • Next: Resources

Quick search

Support

Feature suggestions, new ideas, and Pull Requests are really welcome. We cooperate through the graceful project page on GitHub.

I you want to financially support graceful you can buy a book from one of project creators:

Graceful guide¶

  • Resources
  • Generic API resources
    • RetrieveAPI
    • RetrieveUpdateAPI
    • RetrieveUpdateDeleteAPI
    • ListAPI
    • ListCreateAPI
    • Paginated generic resources
    • Generic resources without serialization
    • Guide for creating resources in bulk
      • Completely separate bulk and single resource creation
      • Deferred saves
      • Utilize your storage transactions
  • Parameters
    • Custom parameters
    • Parameter validation
    • Handling multiple occurences of parameters
      • Order of values and ordered data
      • Custom containers
  • Serializers and fields
    • Field arguments
    • Field validation
    • Resource validation
    • Custom fields
  • Authentication and authorization
    • Authentication - identifying the users
      • User objects and working with user storages
      • Implictit authentication without user storages
      • Custom authentication middleware
    • Authorization - restricting access to the endpoint
    • Heterogenous authentication
    • Practical example – authentication with redis backend
  • Working with resources
    • Dealing with falcon context objects
  • Content types
  • Documenting your API
    • Using self-descriptive resources
    • Self-hosted documentation
      • Serving HTML and using Jinja templates in falcon
      • Populating templates with resources metadata
      • Formatting resource class docstrings
©2015, Michał Jaworski. | Powered by Sphinx 1.4.8 & Alabaster 0.7.9 | Page source