Book Image

Hands-On RESTful Python Web Services - Second Edition

By : Gaston C. Hillar
1 (1)
Book Image

Hands-On RESTful Python Web Services - Second Edition

1 (1)
By: Gaston C. Hillar

Overview of this book

Python is the language of choice for millions of developers worldwide that builds great web services in RESTful architecture. This second edition of Hands-On RESTful Python Web Services will cover the best tools you can use to build engaging web services. This book shows you how to develop RESTful APIs using the most popular Python frameworks and all the necessary stacks with Python, combined with related libraries and tools. You’ll learn to incorporate all new features of Python 3.7, Flask 1.0.2, Django 2.1, Tornado 5.1, and also a new framework, Pyramid. As you advance through the chapters, you will get to grips with each of these frameworks to build various web services, and be shown use cases and best practices covering when to use a particular framework. You’ll then successfully develop RESTful APIs with all frameworks and understand how each framework processes HTTP requests and routes URLs. You’ll also discover best practices for validation, serialization, and deserialization. In the concluding chapters, you will take advantage of specific features available in certain frameworks such as integrated ORMs, built-in authorization and authentication, and work with asynchronous code. At the end of each framework, you will write tests for RESTful APIs and improve code coverage. By the end of the book, you will have gained a deep understanding of the stacks needed to build RESTful web services.
Table of Contents (19 chapters)
Title Page
Dedication
About Packt
Contributors
Preface
Index

Configuring resource routing and endpoints


We must make the necessary resource routing configurations to call the appropriate methods and pass them all the necessary arguments by defining URL rules. The following lines create the main entry point for the application, initialize it with a Flask application, and configure the resource routing for the service. Open the previously created service/service.py file and add the following lines. The code file for the sample is included in the restful_python_2_01_01 folder, in the Flask01/service/service.py file:

app = Flask(__name__) 
service = Api(app) 
service.add_resource(NotificationList, '/service/notifications/') 
service.add_resource(Notification, '/service/notifications/<int:id>', endpoint='notification_endpoint') 
 
 
if __name__ == '__main__': 
    app.run(debug=True) 

The code creates an instance of the flask_restful.Api class and saves it in the service variable. Each call to the service.add_resource method routes a URL to a resource, specifically to one of the previously declared subclasses of the flask_restful.Resource superclass. When there is a request to the service and the URL matches one of the URLs specified in the service.add_resource method, Flask will call the method that matches the HTTP verb in the request for the specified class. The method follows standard Flask routing rules.

For example, the following line will make an HTTP GET request to /service/notifications/ without any additional parameters to call the NotificationList.get method:

service.add_resource(NotificationList, '/service/notifications/') 

Flask will pass the URL variables to the called method as arguments. For example, the following line will make an HTTP GET request to /service/notifications/26 to call the Notification.get method, with 26 passed as the value for the id argument:

service.add_resource(Notification, '/service/notifications/<int:id>', endpoint='notification_endpoint')

In addition, we can specify a string value for the endpoint argument to make it easy to reference the specified route in the fields.Url fields. We pass the same endpoint name, 'notification_endpoint', as an argument in the uri field declared as fields.Url in the notification_fields dictionary that we use to render each NotificationModel instance. This way, fields.Url will generate a URI that considers this route.

We just required a few lines of code to configure resource routing and endpoints. The last line just calls the app.run method to start the Flask application, with the debug argument set to True to enable debugging. In this case, we start the application by calling the run method to immediately launch a local server. We could also achieve the same goal by using the flask command-line script. However, this option would require us to configure environment variables and the instructions are different for the platforms that we are covering in this book: macOS, Windows, and Linux.

Note

As with any other web framework, you should never enable debugging in a production environment.