https://github.com/yenilikci/flask-bookmark-api

Flask REST API with Sqlalchemy and Flasgger
https://github.com/yenilikci/flask-bookmark-api

flasgger flask flask-json flask-jwt-extended sql-alchemy validators werkzeug

Last synced: about 4 hours ago
JSON representation

Flask REST API with Sqlalchemy and Flasgger

• Host: GitHub
• URL: https://github.com/yenilikci/flask-bookmark-api
• Owner: yenilikci
• Created: 2022-04-03T11:56:24.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-04-17T21:09:38.000Z (over 2 years ago)
• Last Synced: 2023-03-06T14:35:07.777Z (over 1 year ago)
• Topics: flasgger, flask, flask-json, flask-jwt-extended, sql-alchemy, validators, werkzeug
• Language: Python
• Homepage:
• Size: 57.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# flask-bookmark-api

## packages

✨ flask 

✨ werkzeug.security

✨ flask_jwt_extended

✨ flasgger 

✨ flask_sqlalchemy 

✨ validators

✨ flask.json

## endpoints

| Endpoint  | Http Request Method  | Body  | Params  | Args | Description  |

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

| /api/v1/auth/register  |  POST | {"username":"username","email":"[email protected]","password":"M12345."}  | Empty  | Empty | It allows us to register the user. |

| /api/v1/auth/login  |  POST | {"email":"[email protected]","password":"M12345."}  | Empty  | Empty |It allows us to login.

| /api/v1/auth/me  | GET  | Empty  | Empty  | Empty | It returns our username and email information. |

| /api/v1/auth/token/refresh  |  POST | Empty  |  Empty | Empty | Creates a new access token.  |

| /api/v1/bookmarks/  |  GET | Empty  | Empty | page=1&per_page=5  | Get bookmarks by pagination. |

| /api/v1/bookmarks/   | POST  | {"body":"Comlaf","url":"comlaf.com"}   | Empty  | Empty  | Creates a bookmark. |

| /api/v1/bookmarks/:id | GET | Empty | id:int | Empty |  Get the bookmark by id. | 

| /api/v1/bookmarks/:id | PUT & PATCH | Empty | id:int | Empty | Update bookmark by id. |

| /api/v1/bookmarks/:id | DELETE | Empty | id:int | Empty | Delete bookmark by id. |

| /api/v1/bookmarks/stats | GET | Empty | Empty | Empty | Get bookmarks with visit information. |