https://github.com/jod35/author-api-v3
This is the third version of the CRUD Author REST API that uses MongoDB.
https://github.com/jod35/author-api-v3
flask marshmallow mongodb
Last synced: about 2 months ago
JSON representation
This is the third version of the CRUD Author REST API that uses MongoDB.
- Host: GitHub
- URL: https://github.com/jod35/author-api-v3
- Owner: jod35
- Created: 2020-07-31T11:38:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-31T11:40:05.000Z (almost 6 years ago)
- Last Synced: 2025-06-24T23:07:27.665Z (about 1 year ago)
- Topics: flask, marshmallow, mongodb
- 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 V3
This is a third version of the AuthorApi I created. It has some added functionality like JSON serialization and deserialization with Marshmallow and data storage with NoSQL (MongoDB).
## Built With
- Flask
- Flask Marshmallow
- Flask MongoEngine
- MongoDb
## 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,
- Make sure your MongoDB is installed.
- Start your MongoDB server ` sudo mongod `
- Enter the command in your termainal ` export FLASK_APP=wsgi.py`
- Finally run the appliaction with ` flask run `
## Author
[Ssali Jonathan (Jod35)](https://github.com/jod35)