to understand the concept and the need of suffixed responders, let us define a studentresource class. it consists of an on_get() responder that converts the students a list of dict objects to json and returns as its response.

let us also add on_post() responder that reads the data from the incoming request and adds a new dict object in the list.

import falcon
import json
from waitress import serve
students = [
   {"id": 1, "name": "ravi", "percent": 75.50},
   {"id": 2, "name": "mona", "percent": 80.00},
   {"id": 3, "name": "mathews", "percent": 65.25},
]
class studentresource:
   def on_get(self, req, resp):
      resp.text = json.dumps(students)
      resp.status = falcon.http_ok
      resp.content_type = falcon.media_json
   def on_post(self, req, resp):
      student = json.load(req.bounded_stream)
      students.append(student)
      resp.text = "student added successfully."
      resp.status = falcon.http_ok
      resp.content_type = falcon.media_text

using add_route() function of the falcon's app object, we add /students route.

app = falcon.app()
app.add_route("/students", studentresource())

after starting the server, we can test the get and post requests from httpie command line −

http get localhost:8000/students
http/1.1 200 ok
content-length: 187
content-type: application/json
date: mon, 18 apr 2022 06:21:02 gmt
server: waitress
[
   {
      "id": 1,
      "name": "ravi",
      "percent": 75.5
   },
   {
      "id": 2,
      "name": "mona",
      "percent": 80.0
   },
   {
      "id": 3,
      "name": "mathews",
      "percent": 65.25
   }
]
http post localhost:8000/students id=4 name="prachi"
percent=59.90
http/1.1 200 ok
content-length: 27
content-type: text/plain; charset=utf-8
date: mon, 18 apr 2022 06:20:51 gmt
server: waitress
student added successfully.

invoking on_get() again confirms the addition of new students resource.

http get localhost:8000/students
http/1.1 200 ok
content-length: 187
content-type: application/json
date: mon, 18 apr 2022 06:21:02 gmt
server: waitress
[
   {
      "id": 1,
      "name": "ravi",
      "percent": 75.5
   },
   {
      "id": 2,
      "name": "mona",
      "percent": 80.0
   },
   {
      "id": 3,
      "name": "mathews",
      "percent": 65.25
   },
   {
      "id": "4",
      "name": "prachi",
      "percent": "59.90"
   }
]

at this stage, we would like to have a get responder method in studentresource class that reads the id parameter from the url and retrieves a corresponding dict object of from the list.

in other words, the url of the format /student/{id} should be associated to the get method in the resource class. but obviously, a class cannot have two methods of same name. hence, we define to use suffix parameter for the add_route() method to distinguish between the two definitions of on_get() responders.

a route with id parameter is added to the application object by specifying suffix ='student'.

app.add_route("/students/{id:int}", studentresource(), suffix='student')

we can now add another definition of on_get() method with this suffix, so that the name of this responder is on_get_student(), as follows −

def on_get_student(self, req, resp, id):
   resp.text = json.dumps(students[id-1])
   resp.status = falcon.http_ok
   resp.content_type = falcon.media_json

start the waitress server after adding the new route and on_get_student() responder and test this url as follows −

http get localhost:8000/students/2
http/1.1 200 ok
content-length: 42
content-type: application/json
date: mon, 18 apr 2022 06:21:05 gmty
server: waitress
{
   "id": 2,
   "name": "mona",
   "percent": 80.0
}

note that the on_put() responder (to update a resource) and on_delete() responder (to delete a resource) will also get invoked when the url route /students/{id:int} is requested by the client with appropriate request header.

we have already added this route with student as the suffix. hence, on_put_student() method parses the path parameter in an integer variable. the json representation of the item with given id is fetched and updated with the data provided in the put request.

def on_put_student(self, req, resp, id):
   student=students[id-1]
   data = json.load(req.bounded_stream)

   student.update(data)
   resp.text = json.dumps(student)
   resp.status = falcon.http_ok
   resp.content_type = falcon.media_json

the on_delete_student() responder simply deletes the item with the id specified in the delete request. the list of remaining resources is returned.

def on_delete_student(self, req, resp, id):
   students.pop(id-1)
   resp.text = json.dumps(students)
   resp.status = falcon.http_ok
   resp.content_type = falcon.media_json

we can test the put and delete operations of the api with httpie commands −

http put localhost:8000/students/2 id=3 name="mathews"
percent=55
http/1.1 200 ok
content-length: 46
content-type: application/json
date: sat, 18 apr 2022 10:13:00 gmt
server: waitress
{
   "id": "3",
   "name": "mathews",
   "percent": "55"
}
http delete localhost:8000/students/2
http/1.1 200 ok
content-length: 92
content-type: application/json
date: sat, 18 apr 2022 10:18:00 gmt
server: waitress
[
   {
      "id": 1,
      "name": "ravi",
      "percent": 75.5
   },
   {
      "id": 3,
      "name": "mathews",
      "percent": 65.25
   }
]

the complete code of this api (studentapi.py) is as under −

import falcon
import json
from waitress import serve
students = [
   {"id": 1, "name": "ravi", "percent": 75.50},
   {"id": 2, "name": "mona", "percent": 80.00},
   {"id": 3, "name": "mathews", "percent": 65.25},
]
class studentresource:
   def on_get(self, req, resp):
      resp.text = json.dumps(students)
      resp.status = falcon.http_ok
      resp.content_type = falcon.media_json
   def on_post(self, req, resp):
      student = json.load(req.bounded_stream)
      students.append(student)
      resp.text = "student added successfully."
      resp.status = falcon.http_ok
      resp.content_type = falcon.media_text
   def on_get_student(self, req, resp, id):
      resp.text = json.dumps(students[id-1])
      resp.status = falcon.http_ok
      resp.content_type = falcon.media_json
   def on_put_student(self, req, resp, id):
      student=students[id-1]
      data = json.load(req.bounded_stream)

      student.update(data)

      resp.text = json.dumps(student)
      resp.status = falcon.http_ok
      resp.content_type = falcon.media_json
   def on_delete_student(self, req, resp, id):
      students.pop(id-1)
      print (students)
      resp.text = json.dumps(students)
      resp.status = falcon.http_ok
      resp.content_type = falcon.media_json
app = falcon.app()
app.add_route("/students", studentresource())
app.add_route("/students/{id:int}", studentresource(), suffix='student')
if __name__ == '__main__':
   serve(app, host='0.0.0.0', port=8000)

Save or share this article