By leveraging Swagger UI, you’ll create handy documentation for your API along the way. That way, you’ll have the opportunity to test how your API works at each stage of this tutorial and get a useful overview of all your endpoints. In this three-part tutorial series, you’ll build a REST API to keep track of notes for people that may visit you throughout the year.
Every new feature is added to a fully working application and tested. We also help you understand more about how to build features incrementally so you can get them to your users quickly and minimize risk. When we want to consume these APIs, which are also known as endpoints, we need our clients to place their requests to the server for resources. The client should be a different application that will make the request.
Source code and course GitHub repository
The version string is important because some parts of the OpenAPI structure may change over time. Flask comes with the Jinja Templating Engine, which enables you to enhance your templates.
It’s for anyone who has wants to leverage Eve to build RESTful APIs. We do assume you know basic Python concepts but advanced features and knowledge of MongoDB, Flask, and REST is not required. Flask-RESTful provides an extension to Flask for building REST APIs. Flask-RESTful was initially developed as an internal project at Twilio, built to power their public and internal APIs. Once you’ve mastered these basic skills, you’ll proceed to apply the concepts to create your first web application with Python and Flask. Contrary to monolithic frameworks like Django that force its coding conventions on you as a full stack developer, Flask is rather lightweight and less demanding. If you’d like to be productive at back-end web development then you should learn the Flask framework by Python.
Installing Flask and Flask_RESTful
When your Flask app finds the provided last name in PEOPLE, then it returns the data for this particular person. If the data in the request body is valid, you update PEOPLE in line 13 and respond with the new object and a 201 HTTP code in line 18. You raise the error response when the request body doesn’t contain a last name or when a person with this last name already exists. You can even try the python api design endpoint out by clicking the Try it out button. The Swagger UI API documentation gives you a way to explore and experiment with the API without having to write any code to do so. You then define the PEOPLE dictionary data structure in line 8, which is the data you’ll work with in this part of the tutorial series. Part of the app instance creation includes the parameter specification_dir in line 6.
- Most modern web applications are powered by a REST API under the hood.
- When you are finished with this course, you will have a foundational understanding of how to build a REST API using Flask that will help you immensely as you create APIs in the future.
- In regards to your question, it seems this tutorial has some prerequisites.
- It also has documentation that will address where the data should start with the developer.