Serving Other Systems From a Django Application

Share the logic, not the views

The temptation is to duplicate business rules between web views and API endpoints. That duplication drifts, and the two paths eventually behave differently.

Put the business logic in a service layer that both the web views and the API call. Then a rule change applies everywhere by construction.

Permissions must apply identically

• The same record-level filtering as the web interface
• The same action permissions
• Tested adversarially, with tokens from different users
• Applied to list endpoints, not just detail ones

An API that bypasses your permission model is a hole in it, and it is frequently discovered by someone exploring rather than by a test.

Design for the consumer

1. Consistent structure across every endpoint
2. Meaningful status codes, not 200 with an error in the body
3. Pagination on every collection, from the start
4. Filtering and ordering where consumers will need it
5. Expose business concepts, not your table structure

Version it from the beginning

Adding versioning after the first consumer means either breaking them or maintaining an unversioned path forever. A path prefix costs nothing at the start.

Then be explicit about what constitutes a breaking change and announce deprecations with real dates.

Rate limit, including internally

Frequently asked questions