Just starting off with Flask, following along at http://flask.pocoo.org/docs/views/
Say I have a basic REST api, in this case for symptoms:
/
GET - list
POST - create
/<symptomid>
GET - detail
PUT - replace
PATCH - patch
DELETE - delete
I can implement this pretty cleanly with Flask's MethodView
as follows:
from flask import Blueprint, request, g
from flask.views import MethodView
#...
mod = Blueprint('api', __name__, url_prefix='/api')
class SymptomAPI(MethodView):
""" ... """
url = "/symptoms/"
def get(self, uid):
if uid is None:
return self.list()
else:
return self.detail(uid)
def list(self):
# ...
def post(self):
# ...
def detail(self, uid):
# ...
def put(self, uid):
# ...
def patch(self, uid):
# ...
def delete(self, uid):
# ...
@classmethod
def register(cls, mod):
symfunc = cls.as_view("symptom_api")
mod.add_url_rule(cls.url, defaults={"uid": None}, view_func=symfunc,
methods=["GET"])
mod.add_url_rule(cls.url, view_func=symfunc, methods=["POST"])
mod.add_url_rule('%s<int:uid>' % cls.url, view_func=symfunc,
methods=['GET', 'PUT', 'PATCH', 'DELETE'])
SymptomAPI.register(mod)
But, let's say I would like to attach another api on these individual symptoms:
/<symptomid>/diagnoses/
GET - list diags for symptom
POST - {id: diagid} - create relation with diagnosis
/<symptomid>/diagnoses/<diagnosisid>
GET - probability symptom given diag
PUT - update probability of symptom given diag
DELETE - remove diag - symptom relation
I would then have 4 GETs instead of two as above.
MethodView
be appropriate for this design? (if the design is not bad)So ... in writing this question, I have found a decent solution. As long as I'm here, I might as well post the question and the solution I have. Any feedback would still be greatly appreciated.
I think the design is ok. MethodView
should be pretty awesome for it. You can put the routes together like so:
class SymptomDiagnosisAPI(MethodView):
"""
/<symptom_id>/diagnoses/
GET - list diags for symptoms
POST - {id: diagid} - create relation with diagnosis
/<symptom_id>/diagnoses/<diagnosis_id>
GET - probability symptom given diag
PUT - update probability of symptom given diag
DELETE - remove diag - symptom relation
"""
def get(self, symptom_id, diagnosis_id):
if diagnosis_id is None:
return self.list_diagnoses(symptom_id)
else:
return self.symptom_diagnosis_detail(symptom_id, diagnosis_id)
def list_diagnoses(self, symptom_id):
# ...
def post(self, symptom_id):
# ...
def symptom_diagnosis_detail(self, symptom_id, diagnosis_id):
# ...
def put(self, symptom_id, diagnosis_id):
# ...
def delete(self, symptom_id, diagnosis_id):
# ...
@classmethod
def register(cls, mod):
url = "/symptoms/<int:symptom_id>/diagnoses/"
f = cls.as_view("symptom_diagnosis_api")
mod.add_url_rule(url, view_func=f, methods=["GET"],
defaults={"diagnosis_id": None})
mod.add_url_rule(url, view_func=f, methods=["POST"])
mod.add_url_rule('%s<int:diagnosis_id>' % url, view_func=f,
methods=['GET', 'PUT', 'DELETE'])
SymptomDiagnosisAPI.register(mod)
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With