Calling this URL from our browser (or any frontend) should give us the desired output. We’ll keep things simple and call this particular route /greetings. Now that we have restful api python flask initialized the Flask object, we can go ahead and write our first API. For now, assume you need an API that returns a simple text saying May the force be with you!
Any other HTTP call would be met by Error 405 Method not allowed. Flask achieves this with something called a Decorator in Python. Simply put, a decorator is a function that wraps another function’s execution within itself. An API route is, simply put, the URL on which the API will exist.
Creating RESTful Web APIs using Flask and Python
Your Flask app knows what to serve based on your API specification in swagger.yml. Additionally, Connexion uses swagger.yml to create API documentation for you. Before continuing on your way to building out your REST API with multiple endpoints, take a moment and explore the API a bit more in the next section. When you use OpenAPI with Swagger, you can create a user interface (UI) to explore the API.
When you define an API, you must include the version of your OpenAPI definition. The version string is important because some parts of the OpenAPI structure may change over time. In the next sections, you’ll expand the project and add your first REST API endpoints.
Understanding HTTP Requests Through Flask REST API
When you interact with a database in your Python code, you may think twice about whether you want to write pure SQL commands. As you learned above, writing SQL may not only feel inconvenient, but it can cause security issues. If you don’t want to worry too much about database interaction, a package like SQLAlchemy can help you out.
- You’re referencing Note from within NoteSchema, so you must place NoteSchema underneath your Note class definition to prevent errors.
- However, as it is a newer framework, many more resources and libraries are compatible with frameworks like Django and Flask but not with FastAPI.
- This elegant framework built for high-performance and fast-to-code APIs is not one to miss.
- Besides that, we have also changed the implementation of both methods that deal with incomes.
- You’ll extend the home.html file later to work with the REST API that you’re developing.
- This class inherits from another superclass called Schema that belongs on a package not yet installed.
