I am building my first REST API using data stored in my MongoDB Atlas Database. I tried to read the REST API conventions with the versioning, using plural nouns for resources and sending the right error codes. I wonder if the following code correctly follows Good Practices for REST APIs and if there is anything that can be written better or more neatly.
connection_str = config.connection_str
db_name = config.db_name
app = Flask(__name__)
cors = CORS(app)
client = MongoClient(connection_str)
db = client.get_database(db_name)
@app.route("/api/v1/players", methods = ['GET'])
def get_all_players():
# TODO: Implement pagination
"""
returns a list of players
"""
try:
players = db.players.find()
output = []
for player in players:
output.append({
'name': player['name'],
'position': player['position'],
'nationality': player['nation'],
'position': player['position'],
'foot': player['foot'],
'age': utils.date_to_age(player['birth_date']),
'profile_img': player['profile_img'],
'abilities': player['abilities']
})
return jsonify({'result': output})
except:
return jsonify({
'result': 'failure',
"error": 400,
"message": 'Bad Request'}), 400
@app.route("/api/v1/players/<name>", methods = ['GET'])
def get_player(name):
"""
returns an object of a player given a name
"""
try:
player = db.players.find_one({'name': name})
output = {
'name': player['name'],
'position': player['position'],
'nationality': player['nation'],
'position': player['position'],
'foot': player['foot'],
'age': utils.date_to_age(player['birth_date']),
'profile_img': player['profile_img'],
'abilities': player['abilities']
}
return jsonify({'result': output})
except:
return jsonify({
'result': 'failure',
"error": 400,
"message": "Bad Request (Double check player's name)"}), 400
if __name__ == "__main__":
# app.run(ssl_context='adhoc')
app.run()
The API doesn't do that much right now. It just reads data in the DB, but I want to see if any style can be fixed at this early stage.
