An open API service indexing awesome lists of open source software.

https://github.com/genza999/school-crud-api

A project showing examples of CRUD apis that extract different forms of data from a csv file using mongo and the implementation of the swagger UI to explore these apis
https://github.com/genza999/school-crud-api

Last synced: 3 months ago
JSON representation

A project showing examples of CRUD apis that extract different forms of data from a csv file using mongo and the implementation of the swagger UI to explore these apis

Awesome Lists containing this project

README

          

# About

Building a simple web API that carries out all CRUD operations on a specific data set queried from the large data.csv file.

### Technologies Used

* Python
* Flask
* Swagger
* MongoDb
* Virtual environment

### Use the following command to generate the requirements.txt file that includes all the external dependencies used in the project
```
pip freeze >requirements.txt
```

### Use the command below to build a perfect replica of the virtual environment(Downloads all the dependencies in the requirements file):

```
pip install -r requirements.txt
```

### Use the following command to start the server(Make sure your Mongodb server is already up):
```
python app.py runserver
```

### Open your browser and navigate to the following url to explore the CRUD apis with the swagger UI:
```
localhost:5000
```

### Author

Kisekka David