An extremely lean and basic social media REST API built with Django and Django-REST-Framework (DRF) that allows users to register for accounts, create posts, comment on posts and pin (like) other posts to the wall. Authentication is done using SimpleJWT. Testing implemented with django-nose and coverage (see coverage report below).
Project Goals:
- Complete a project with Django and Django-REST-Framework
- Implement a test driven approach for developing a REST API
- Use Travis-CI to run automated tests when committing new code
- Learn class based and generic views in Django and DRF
GET->/posts/-> returns current users posts (auth required)POST->/posts/-> create new post (auth required)GET->/posts/<uuid>/-> return post detailsPUT->/posts/<uuid>/-> make an edit to the post text (author only)DELETE->/posts/<uuid>/-> delete post (author only)PUT->/posts/<uuid>/pin/-> increment post pins by 1 (auth required)GET->/posts/<uuid>/comments/-> returns all comments for post with uuidPOST->/posts/<uuid>/comments/-> create new comment on post with uuid (auth required)GET->/posts/<post_uuid>/comments/<comment_uuid>/-> comment detailsDELETE->/posts/<post_uuid>/comments/<comment_uuid>/-> delete comment (author only)
View the users urls.py file for the user account endpoints.
Name Stmts Miss Cover
------------------------------------------
posts/permissions.py 6 0 100%
posts/serializers.py 17 0 100%
posts/views.py 45 0 100%
users/managers.py 18 7 61%
users/serializers.py 23 0 100%
users/views.py 32 2 94%
------------------------------------------
TOTAL 141 9 94%
----------------------------------------------------------------------
Ran 40 tests in 6.803s
OK
Written by Nicholas Cannon