sohaibfarooqi / flask-stargate

Easy RESTful JSON APIs.

Flask-Stargate

This project is currently under development. First version will soon be released. Currently flask-stargate has only test for GET and POST endpoints. More tests and features will be added soon. Docs for PATCH and DELETE method will be updated after test completion.

This code is largely inspired from Flask-Restless. It is indeed a great example for someone who wants to learn and understand how RESTFul APIs should be coded.

For quickstart please check example. For Documentation check out Docs.

Features

Currently it supports following features:

• Expose a restful interface against a resource

• Customize endpoint

  • Modify url prefix.
  • Specify view decorators.
  • Specify resource fields for response.
  • Exclude some fields form response.
  • Specify a different primary key for resource. Default is id.
  • HTTP methods to be allowed on a resource

• Collection filteration

  • Filters
  • Sorting
  • Grouping
  • Pagination

• Partial Response.
• Resource Expansion.
• Resource attribute and relationship updation.
• Resource Deletion.

To-Do List

Stargate will provide following feature in future

• Authentication/Authorization.
• Rate limiting.
• Schema Views.
• Field validations.

Final Notes

Feel free to contribute to this project. Suggest me changes for the betterment of this project. I will keep adding new features to this project.

Thanks.!