That way they can use the id in subsequent requests to insert temperatures related to the new room. So create an ElephantSQL account if you don’t have one already, and create a “Tiny Turtle ” database. Choose a region for the database that is physically close to you, so that requests are faster. GET /api/average will let clients request the average temperature across all rooms, since we started gathering data.

restful api python flask

When our user requests an entry or set of entries, our API pulls that information from the database by building and executing an SQL query. This iteration of our API also allows for filtering by more than one field. We’ll discuss potential uses for this functionality after examining our code more closely.

Create a New Person

For this tutorial, you will need Python 3 and the Flask web framework. You’ll also require a web browser and a text editor (such as Notepad++ or BBEdit). Join the growing number of people supporting Programming Historian so we can continue to share knowledge free of charge. Comments must be respectful, constructive, and relevant to the topic of the guide. Before posting, consider if your comment would be better addressed by contacting ourSupport team or asking on ourCommunity Site. Notice the addition of DELETE is passed to the method’s parameter in the annotation.

  • The import connexion statement adds the module to the program.
  • You’ll test your API with Swagger UI API documentation that you’ll build along the way.
  • This field must be unique because you’re using lname as the identifier for a person in a REST API URL.
  • You can use the Windows, macOS, or Linux operating systems to complete this tutorial, and those few instructions that are not the same across platforms will be explicitly noted.
  • This JSON object resembles the Person component that you were defining earlier in swagger.yml and that you’re referencing with $ref in schema.

Before you define new API paths in swagger.yml, you’ll add a new block for components. Components are building restful api python flask blocks in your OpenAPI specification that you can reference from other parts of your specification.


This variable allows you to query for a specific item in your datastore. The id refers to the index in the list related to a specific instance of a programming language resource. This presents a problem once clients can delete items from the datastore.

In this article, we will build a REST API in Python using the Flask framework. Flask is a popular micro framework for building web applications. Since it is a micro-framework, it is very easy to use and lacks most of the advanced functionality which is found in a full-fledged framework. REST API services let you interact with the database by simply doing HTTP requests. In this article you learn how to write a REST server using the Flask. The only value that this class adds for our application is that it hardcodes the type of transaction. This type is a Python enumerator, which we still have to create, that will help us filter transactions in the future.