Skip to content

day 29 update #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pkiczko wants to merge 1 commit into
base: master
Choose a base branch
from
Open

day 29 update #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 35 additions & 46 deletions 29_Day/29_building_API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
![30DaysOfPython](../images/[email protected])

- [Day 29](#day-29)
- [Building API](#building-api)
- [Building an API](#building-an-api)
- [Structure of an API](#structure-of-an-api)
- [Retrieving data using get](#retrieving-data-using-get)
- [Getting a document by id](#getting-a-document-by-id)
Expand All @@ -31,15 +31,15 @@

## Day 29

## Building API
## Building an API

An example [API](https://restcountries.eu/rest/v2/all).
In this section, we will cove a RESTful API that uses HTTP request methods to GET, PUT, POST and DELETE data.
In this section, we will cover a RESTful API that uses HTTP request methods to GET, PUT, POST and DELETE data.

RESTful API is an application program interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. In the previous sections, we have learned about python, flask and mongoDB. We will use the knowledge we acquire to develop a RESTful API using python flask and mongoDB. Every application which has CRUD(Create, Read, Update, Delete) operation has an API to create data, to get data, to update data or to delete data from database.
RESTful API is an application program interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. In the previous sections, we have learned about python, flask and mongoDB. We will use the knowledge we acquired to develop a RESTful API using python flask and mongoDB. Every application which has CRUD (Create, Read, Update, Delete) operations has an API to create data, to get data, to update data or to delete data from the database.

The browser can handle only get request. Therefore, we have to have a tool which can help us to handle all request methods(GET, POST, PUT, DELETE). [Postman](https://www.getpostman.com/) is a very popular tool when it comes to API development. So, if you like to do this section you need to [download postman](https://www.getpostman.com/)
![Postman](./images/postman.png)
The browser can handle only get request. Therefore, we have to have a tool which can help us to handle all request methods (GET, POST, PUT, DELETE). [Postman](https://www.getpostman.com/) is a very popular tool when it comes to API development. So, if you want to do this section you will require such a tool - [download postman](https://www.getpostman.com/)
![Postman](../images/postman.png)

### Structure of an API

Expand Down Expand Up @@ -71,13 +71,12 @@ To implement this API, we will use:

### Retrieving data using get

In this step, let's use dummy data and return it as a json. To return it as json, will use json module and Response module.
In this step, let's use dummy data and return it as a json. To return it as json, we will use json module and Response module.

```py
# let's import the flask

from flask import Flask, Response
import json
import os

app = Flask(__name__)

Expand Down Expand Up @@ -117,18 +116,19 @@ When you request the http://localhost:5000/api/v1.0/students url on the browser

![Get on browser](../images/get_on_browser.png)

When you request the http://localhost:5000/api/v1.0/students url on the browser you will get this:
When you request the http://localhost:5000/api/v1.0/students url in Postman with the GET mothod, you will get this:

![Get on postman](../images/get_on_postman.png)

In stead of displaying dummy data let's connect the flask application with MongoDB and let's get data from mongoDB database.
Instead of displaying dummy data let's connect the flask application with MongoDB and let's get data from mongoDB database.

```py
# let's import the flask

from flask import Flask, Response
import json
import os
import pymongo
from bson.json_util import dumps



app = Flask(__name__)
Expand All @@ -140,9 +140,7 @@ db = client['thirty_days_of_python'] # accessing the database

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():

return Response(json.dumps(student), mimetype='application/json')

return Response(dumps(db.students.find()), mimetype='application/json')

if __name__ == '__main__':
# for deployment
Expand Down Expand Up @@ -185,20 +183,18 @@ By connecting the flask, we can fetch students collection data from the thirty_d
]
```

### Getting a document by id
### Getting a Document by Id

We can access signle document using an id, let's access Asabeneh using his id.
http://localhost:5000/api/v1.0/students/5df68a21f106fe2d315bbc8b

```py
# let's import the flask

from flask import Flask, Response
import json
from bson.objectid import ObjectId
import json
from bson.json_util import dumps
import os
import pymongo
from bson.json_util import dumps
from bson.objectid import ObjectId


app = Flask(__name__)
Expand All @@ -210,8 +206,8 @@ db = client['thirty_days_of_python'] # accessing the database

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():
return Response(dumps(db.students.find()), mimetype='application/json')

return Response(json.dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students/<id>', methods = ['GET'])
def single_student (id):
student = db.students.find({'_id':ObjectId(id)})
Expand All @@ -238,19 +234,18 @@ if __name__ == '__main__':
]
```

### Creating data using POST
### Creating Data Using POST

We use the POST request method to create data

```py
# let's import the flask

from flask import Flask, Response
import json
from bson.objectid import ObjectId
import json
from bson.json_util import dumps
import os
import pymongo
from bson.json_util import dumps
from bson.objectid import ObjectId

from datetime import datetime


Expand All @@ -263,8 +258,8 @@ db = client['thirty_days_of_python'] # accessing the database

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():
return Response(dumps(db.students.find()), mimetype='application/json')

return Response(json.dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students/<id>', methods = ['GET'])
def single_student (id):
student = db.students.find({'_id':ObjectId(id)})
Expand All @@ -290,25 +285,22 @@ def create_student ():
}
db.students.insert_one(student)
return ;
def update_student (id):
if __name__ == '__main__':
# for deployment
# to make it work for both production and development
port = int(os.environ.get("PORT", 5000))
app.run(debug=True, host='0.0.0.0', port=port)
```

### Updating using PUT
### Updating Using PUT

```py
# let's import the flask

from flask import Flask, Response
import json
from bson.objectid import ObjectId
import json
from bson.json_util import dumps
import os
import pymongo
from bson.json_util import dumps
from bson.objectid import ObjectId
from datetime import datetime


Expand All @@ -321,8 +313,8 @@ db = client['thirty_days_of_python'] # accessing the database

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():
return Response(dumps(db.students.find()), mimetype='application/json')

return Response(json.dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students/<id>', methods = ['GET'])
def single_student (id):
student = db.students.find({'_id':ObjectId(id)})
Expand Down Expand Up @@ -371,25 +363,22 @@ def update_student (id):
db.students.update_one(query, student)
# return Response(dumps({"result":"a new student has been created"}), mimetype='application/json')
return
def update_student (id):
if __name__ == '__main__':
# for deployment
# to make it work for both production and development
port = int(os.environ.get("PORT", 5000))
app.run(debug=True, host='0.0.0.0', port=port)
```

### Deleting a document using Delete
### Deleting a Document Using Delete

```py
# let's import the flask

from flask import Flask, Response
import json
from bson.objectid import ObjectId
import json
from bson.json_util import dumps
import os
import pymongo
from bson.json_util import dumps
from bson.objectid import ObjectId
from datetime import datetime


Expand All @@ -402,8 +391,8 @@ db = client['thirty_days_of_python'] # accessing the database

@app.route('/api/v1.0/students', methods = ['GET'])
def students ():
return Response(dumps(db.students.find()), mimetype='application/json')

return Response(json.dumps(student), mimetype='application/json')
@app.route('/api/v1.0/students/<id>', methods = ['GET'])
def single_student (id):
student = db.students.find({'_id':ObjectId(id)})
Expand Down