Skip to content

Latest commit

 

History

History
102 lines (96 loc) · 2.5 KB

README.md

File metadata and controls

102 lines (96 loc) · 2.5 KB
Raw

Social media API

API that allows users to exchange posts on social media simulation

Try it yourself!

API is deployed on heroku:
https://social-media-api-verevkin.herokuapp.com/posts
Interactive documentation:
https://social-media-api-verevkin.herokuapp.com/docs

Preview, examples

  • Fetch published posts

GET https://social-media-api-verevkin.herokuapp.com/posts

[{
    "Post": {
        "title": "Wassup",
        "content": "Who want to chat?",
        "published": true,
        "id": 2,
        "created_at": "2022-04-09T13:13:26.930493+00:00",
        "owner": {
            "id": 1,
            "email": "[email protected]",
            "created_at": "2022-04-03T20:14:56.543206+00:00"
        }
    },
    "likes": 4
}, {
    "Post": {
        "title": "Hi, it's my first post",
        "content": "Happy to be here!",
        "published": true,
        "id": 1,
        "created_at": "2022-04-04T12:27:40.618115+00:00",
        "owner": {
            "id": 3,
            "email": "[email protected]",
            "created_at": "2022-04-01T20:30:40.231458+00:00"
        }
    },
    "likes": 2
}]

  • Create new user

POST https://social-media-api-verevkin.herokuapp.com/users

{
  "email": "[email protected]",
  "password": "MyPassword123?!"
}

  • User login

POST https://social-media-api-verevkin.herokuapp.com/users/login
input:

{
  "username": "[email protected]",
  "password": "MyPassword123?!"
}

output:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxLCJleHAiOjE2NDk1MTc0MTJ9.uIbF5LHfy_AJZ2SLhCTvEXlhMtMLDjUhc9ROsiKypDo",
  "token_type": "bearer"
}

  • Create post

POST https://social-media-api-verevkin.herokuapp.com/posts

{
    "title": "I love tigers",
    "content": "Tigers are great",
    "published": true
}

  • Rate post

POST https://social-media-api-verevkin.herokuapp.com/rate

{
  "post_id": 3,
  "dir": 1
}

Used technologies

  • FastAPI framework
  • PostgreSQL database
  • SQLAlchemy ORM
  • Alembic as database migration tool
  • OAuth2 and JWTokens for users authentication
  • Each query and api feature provided with pytest tests
  • Application is fully automized for CI/CD workflow with GitHub actions
  • Application is dockerized and deployed on heroku

Planned features

  • Dislike feature (direction: -1, youtube answer)
  • Show amount of likes and posts created by user
Aleksandr Verevkin 2022