https://github.com/jod35/author-api-v2
This is version 2 of the author API I built I while ago.
https://github.com/jod35/author-api-v2
database flask marshmallow mysql
Last synced: 3 months ago
JSON representation
This is version 2 of the author API I built I while ago.
- Host: GitHub
- URL: https://github.com/jod35/author-api-v2
- Owner: jod35
- Created: 2020-07-28T09:47:32.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-31T11:42:01.000Z (almost 6 years ago)
- Last Synced: 2025-02-23T21:42:48.785Z (over 1 year ago)
- Topics: database, flask, marshmallow, mysql
- Language: Python
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Author API V2
This is a second version of the AuthorApi I created. It has some added functionality like JSON serialization and deserialization with Marshmallow.
## Built With
- Flask
- Flask Marshmallow
- MySQL
## The API Endpoints
ENDPOINT |METHOD | FUNCTION|
----------|-------|---------|
/authors/ | GET |Get all authors|
/authors/ | POST |Create an author|
/author/id| GET | Get an author with an id|
/author/id| PUT | Update an author with an id|
/author/id| DELETE | Delete an author with an id|
## To get running
1. Clone the project
`git clone https://github.com/jod35/AuthorAPI-V2`
2. Install project Dependencies
` pip3 install -r requirements.txt `
3. To run the API,
- Create the database ` apidb ` (With MySQL of course)
- Edit ` user ` and ` passwd ` to your MySQL database user and password.
- Enter the command in your termainal ` export FLASK_APP=wsgi.py`
- Enter the command in your terminal ` flask shell ` to access the app in the Flask interactive console.
- And then run ` db.create_all() ` to set the database up
- Finally run the appliaction with ` flask run `
## Author
[Ssali Jonathan (Jod35)](https://github.com/jod35)