Yatube API

The Yatube API allows you to interact with the Yatube social network as a user through the API.

Features

1. Getting a complete list of all posts on Yatube
2. Getting a list of posts belonging to a specific group
3. Getting a complete list of comments to all posts
4. Getting a list of comments to a specific post
5. CRUD comments and posts
6. Following/unfollowing a user

Installation

1. Fork and clone the repository
2. Set up a virtual environment
3. Install the dependencies: pip install -r requirements.txt

Usage

Authorization

To get access to the API, create a new user in Yatube and make a POST request to /api/v1/token/ with the username and password, after which you will receive a token. When using the API, pass the token in the header as Authorization: Bearer [token].

Example requests and responses

Sample POST request to /api/v1/posts:

{
    "text":"Chandler and I are getting married!",
}

Sample response:

{
    "id": 3,
    "author": "monicageller",
    "text": "Chandler and I are getting married!",
    "pub_date": "2020-12-25T10:40:32.710136Z",
    "group": null
}

Sample POST request to api/v1/posts/{post_id}/comments/ to add a comment to a post:

{
    "post": 3,
    "text": "My best friend and my sister?!",
}

Sample response:

{
    "id": 1,
    "author": "rossgeller",
    "text": "My best friend and my sister?!",
    "created": "2020-12-25T10:49:56.272056Z",
    "post": 3
}

See the complete API specification (redoc.yaml).

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT