MongoDB RESTful API with Flask

List of MongoDB with PyMongo

1. MongoDB with PyMongo I - Installing MongoDB
2. MongoDB with PyMongo II - Connecting and accessing MongoDB
3. MongoDB with pyMongo III - Range Querying MongoDB
4. MongoDB RESTful API with Flask

In this tutorial, we'll write a code that does RESTful interaction with MongDB.

We'll get some help from Postman for client side while Flask will be on the server side.

The code looks like this:

# mongo.py

from flask import Flask
from flask import jsonify
from flask import request
from flask_pymongo import PyMongo

app = Flask(__name__)

app.config['MONGO_DBNAME'] = 'restdb'
app.config['MONGO_URI'] = 'mongodb://localhost:27017/restdb'

mongo = PyMongo(app)

@app.route('/star', methods=['GET'])
def get_all_stars():
  star = mongo.db.stars
  output = []
  for s in star.find():
    output.append({'name' : s['name'], 'distance' : s['distance']})
  return jsonify({'result' : output})

@app.route('/star/', methods=['GET'])
def get_one_star(name):
  star = mongo.db.stars
  s = star.find_one({'name' : name})
  if s:
    output = {'name' : s['name'], 'distance' : s['distance']}
  else:
    output = "No such name"
  return jsonify({'result' : output})

@app.route('/star', methods=['POST'])
def add_star():
  star = mongo.db.stars
  name = request.json['name']
  distance = request.json['distance']
  star_id = star.insert({'name': name, 'distance': distance})
  new_star = star.find_one({'_id': star_id })
  output = {'name' : new_star['name'], 'distance' : new_star['distance']}
  return jsonify({'result' : output})

if __name__ == '__main__':
    app.run(debug=True)

To run our Flask server, we'll use virtualenv with Python3:

$ virtualenv -p python3 venv
$ source venv/bin/activate

(venv)$ pip install Flask-PyMongo

We can run our code now:

(venv)$ python mongo.py
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 ...

As we can see from the code we have 2 GET requests and 1 POST request.

1. Getting all data in the collection:

   @app.route('/star', methods=['GET'])
   def get_all_stars():
   

2. Getting one data in the collection:

   @app.route('/star/', methods=['GET'])
   def get_one_star(name):
   

3. Posting one data in the collection:

   @app.route('/star', methods=['POST'])
   def add_star():
   

As an example for a GET request, let's request for only one record:

As an example for a POST request, let's add one more data to our collection:

List of MongoDB with PyMongo

1. MongoDB with PyMongo I - Installing MongoDB
2. MongoDB with PyMongo II - Connecting and accessing MongoDB
3. MongoDB with pyMongo III - Range Querying MongoDB
4. MongoDB RESTful API with Flask