Skip to content

Document goals of Django REST Framework JSON API #447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2018
Merged

Document goals of Django REST Framework JSON API #447

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,20 @@ like the following::
}


-----
Goals
-----

As a Django REST Framework JSON API (short DJA) we are trying to address following goals:

1. Support the [JSON API](http://jsonapi.org/) spec to compliance
2. Be as compatible with Django REST Framework as possible
e.g. issues in Django REST Framework should be fixed upstream and not worked around in DJA
Copy link
Collaborator

@mblayman mblayman Jul 24, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line looks good in the plain text, but I think it won't format well in the final documentation. It would look like "... as possible e.g. issues in Django...." I think the line should be wrapped with parentheses.

3. Have sane defaults to be as easy to pick up as possible
4. Be solid and tested with good coverage
5. Be performant


------------
Requirements
------------
Expand Down