encode/apistar

API Schemas & client libraries

tomchristie opened this issue · 1 comments

tomchristie commented

Some initial work for this is now in place, but there's plenty more still to do:

  • Add descriptions to fields and links.
  • Support direct usage of QueryParam, RequestData.
  • Include proper type information in the API Schemas.
  • Include response schemas.
  • Allow for API structure, using includes.
  • Allow for eg _id -> id in function arguments, to work around python keyword-clashes.
  • Allow for explicit naming in Route to override automatic function naming.
  • Figure out encodings on links.
  • API Name
  • API Description
  • API Base URL
  • Document usage of client libraries.
  • Figure out naming - APISchema vs schema module.
  • Returning a schema from a view.
tomchristie commented

We have this now. Still some refinements worth pursuing, but we should tackle anything there as individual issues.