holohup / yatube_api_en Goto Github PK

Exactly! Implementation of REST API for a sample Django project using DRF. The task was to create an API based on redoc-based documentation from scratch: models, request routing, serialization, permissions, JWT, and so on.

After installation, you'll be able to read the docs and test the project, using a built-in web interface, or some kind of software (I would recommend PostMan)

• Python 3.7.13, Django 2.2.16, Django REST Framework 3.12.4, SimpleJWT 4.7.2, PyJWT 2.1.0, Djoser 2.1.0, Pillow 9.2.0, drf-yasg 1.21.4

• This implementation is built on viewsets.
• JWT tokens are used for authentication.
• Read-only access for unauthenticated users to all endpoints except for /follow/.
• Authenticated users are allowed to modify/delete their content, and read-only access in all other cases.

git clone https://github.com/holohup/yatube_api_en && cd yatube_api_en && ./yatube_api_install.sh

The project comes preloaded with some fixtures which are installed on the script execution. There's a registered admin user tester/tester, the admin web interface is accessible at http://127.0.0.1:8000/admin/

You can register a new user from there, or use the admin credentials to get a token by sending a POST request to http://127.0.0.1:8000/api/v1/jwt/create/ containing a JSON:

{
    "username": "string",
    "password": "string"
}

The JWT token will be under the key named "access". After that, set up your software to use it and explore the API at your will!

Choose a link to learn which requests it should accept, which responses it returns, and all the necessary details in a preferred format:

• A JSON view: http://127.0.0.1:8000/swagger.json
• A YAML view: http://127.0.0.1:8000/swagger.yaml
• A swagger-ui view: http://127.0.0.1:8000/swagger/
• A ReDoc view: http://127.0.0.1:8000/redoc/

sequenceDiagram
User ->> API: Would you please delete this post?
API ->> Server: Post deletion service needed immediately!
Server ->> Database: Delete the post ASAP! Code red!
Database ->> Server: Fixed :-Q
Server ->> API: The post has been deleted, what's next?
API ->> User: Oh mighty one! It's done, please accept this 204 status code.

• get post comments

/api/v1/posts/{post_id}/comments/{id}/

Response:

{
-   "id": 0,   
-   "author": "string", 
-   "text": "string",  
-   "created": "2019-08-24T14:15:22Z",  
-   "post": 0
}

Feel free to send all allowed kinds of requests and test my solution back and forth!