Flask API for handling bookmarks
REST API built using flask framework that used for managing bookmarks by individual users.
This app is built using flask framework that helps this api can be cosumed both on andriod or web applications.
API Endpoints
- POST
- user registration
- bookmarks posting
- GET
- user login
- refresh token
- bookmarks
- bookmark/{id}
- bookmark/stats
- bookmark/short_url
- PUT / PATCH
- bookmark/{id}
- DELETE
- bookmark/{id}
Test Live API
API have been configured and deployed using Heroku.
Test Live version by clicking here.
Documentation
Every Aspect of using this API is been documented using flasgger which is a opensource flask extension for extracting open-api specifications which defaultly uses swagger UI to disply documentation
Configuring App with your Front-end
- You can refer the following files to confgure the app in your production
src/config/swagger.py
src/__init__.py
- Currently there is no external DB used, in caseyou want to configure with any other db please do change the following env variable
SQLALCHEMY_DB_URI