kebasyaty/social-network

Solution of test task for StarNavi.

social-network

Usage example django-rest-framework.

Used packages for API

• djangorestframework - django-rest-framework
• django-extra-fields - Для использования поля типа Base64ImageField
• django-cors-middleware - Для разрешения междоменных запросов
• django-oauth-toolkit - Рекомендуемый пакет поддержки OAuth 2.0

Used documentation

• Django REST framework (Home)
• django-rest-framework-russian-documentation (Russian)

Browser - Register an application

• Register an application: http://localhost:8000/o/applications/
• Edit applications: http://localhost:8000/o/applications/

В целях безопасности, добавлены следующие ограничения:

• Client type: Only - "confidential"
• Authorization Grant Type: Only - "authorization-code"

Test OAuth2 provider

• Consumer for test: http://django-oauth-toolkit.herokuapp.com/consumer/

Unit tests

• posts/tests.py

Console

$ sudo apt install httpie

• Get posts: http GET 'http://localhost:8000/api/v1/integrations/posts/' 'Authorization:Bearer access_token'
• Get post: http GET 'http://localhost:8000/api/v1/integrations/posts/{id}/' 'Authorization:Bearer access_token'
• Like: http POST 'http://localhost:8000/api/v1/integrations/posts/{id}/like/' 'Authorization:Bearer access_token'
• Unlike: http POST 'http://localhost:8000/api/v1/integrations/posts/{id}/unlike/' 'Authorization:Bearer access_token'
• Create post: http -f POST 'http://localhost:8000/api/v1/integrations/posts/' 'Authorization:Bearer access_token' title='My Post' message='Hello World!' image='image_base64'
• Update post: http -f PUT 'http://localhost:8000/api/v1/integrations/posts/{id}/' 'Authorization:Bearer access_token' title='My Post ' message='Hello World!'
• Partial update post: http -f PATCH 'http://localhost:8000/api/v1/integrations/posts/{id}/' 'Authorization:Bearer access_token' title='My Post ' message='Hello World!'
• Delete post: http DELETE 'http://localhost:8000/api/v1/integrations/posts/{id}/' 'Authorization:Bearer access_token'
• Get user posts: http GET 'http://localhost:8000/api/v1/integrations/posts/owner/' 'Authorization:Bearer access_token'
• Get user post: http GET 'http://localhost:8000/api/v1/integrations/posts/{id}/owner/' 'Authorization:Bearer access_token'
• Add comment: http -f POST 'http://localhost:8000/api/v1/integrations/posts/{id}/comment/' 'Authorization:Bearer access_token' text='Cool post!!!'
• Sort by latest (default): http GET 'http://localhost:8000/api/v1/integrations/posts/?sort=latest' 'Authorization:Bearer access_token'
• Sort by rating: http GET 'http://localhost:8000/api/v1/integrations/posts/?sort=rating' 'Authorization:Bearer access_token'

Опциональные параметры:

• page - номер страницы
• page_size - количество записей на страницу

Пример результата запроса:

http GET 'http://localhost:8000/api/v1/integrations/posts/10280/' 'Authorization:Bearer UfPvyV7WC6mIcf1W4LVqlBmUsXvwow'

MIT License

MIT License