https://github.com/qbbr/blog-backend-flask

Blog REST API on Flask
https://github.com/qbbr/blog-backend-flask

backend flask python3 rest-api

Last synced: 2 months ago
JSON representation

Blog REST API on Flask

• Host: GitHub
• URL: https://github.com/qbbr/blog-backend-flask
• Owner: qbbr
• License: mit
• Created: 2020-08-30T05:24:15.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-11-21T06:59:17.000Z (over 5 years ago)
• Last Synced: 2025-10-24T13:42:38.849Z (8 months ago)
• Topics: backend, flask, python3, rest-api
• Language: Python
• Homepage:
• Size: 33.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# blog-backend-flask

![API Tests](https://github.com/qbbr/blog-backend-flask/workflows/API%20Tests/badge.svg)

Blog REST API on Flask

see [blog-frontend-vuejs](https://github.com/qbbr/blog-fontend-vuejs)

## depends

 * [python3](https://www.python.org/)

 * [python3-venv](https://docs.python.org/3/library/venv.html)

 * see [requirements.txt](requirements.txt)

## run

```bash

python3 -m venv venv

 . venv/bin/activate

pip install -r requirements.txt

. .env.dev

flask init-db

flask run

```

## routes

| route               | method     | description                      | JWT required |

|---------------------|------------|----------------------------------|--------------|

| /register/          | POST       | create new user                  |              |

| /login/             | POST       | login                            |              |

| /user/profile/      | GET        | get user profile                 | Y            |

| /user/profile/      | PUT, PATCH | update user profile              | Y            |

| /user/profile/      | DELETE     | delete user profile              | Y            |

| /posts/             | GET        | get all posts \w pagination      |              |

| /post/{slug}/       | GET        | get post by slug                 |              |

| /tags/              | GET        | get all tags                     |              |

| /user/posts/        | GET        | get all user posts \w pagination | Y            |

| /user/posts/        | DELETE     | delete all user posts            | Y            |

| /user/post/         | POST       | create user post                 | Y            |

| /user/post/{id}/    | GET        | get user post by id              | Y            |

| /user/post/{id}/    | PUT, PATCH | update user post by id           | Y            |

| /user/post/{id}/    | DELETE     | delete user post by id           | Y            |

| /user/post/md2html/ | POST       | convert markdown to html         | Y            |

## tests

```bash

python -m pytest

```