OpenAPI, Swagger and Python

By

The OpenAPI specification, and the Swagger suite of tools built around it, make it incredibly easy for Python developers to create, document and manually test the RESTful APIs they create.

Regardless of whether a developer builds apps in Flask, Django or FastAPI, so long as the APIs use HTTP endpoints then Swagger plus the OpenAPI specification is a perfect fit.

Swagger for Python

In this complete OpenAPI and Swagger tutorial for Python developers, you'll learn the most important and commonly used features of Swagger and OpenAPI, including the following:

  • How to add Swagger to an existing Flask application.
  • How to document REST and RESTful APIs with OpenAPI.
  • How to use Swagger UI to test Python APIs.
  • How to create Python code with Swagger's OpenAPI generator.
  • The benefits of API first development in Python.

Other than a local installation of Python and an IDE such as VS Code or PyCharm to simplify the development process, there are no prerequisites for this Swagger for Python course.

OpenAPI, Swagger UI and Python screenshot.
The OpenAPI specification makes it easy to document RESTful APIs written in Python.

How to learn Python, Swagger and the OpenAPI

Without the need to download any external tools or register with any vendors, this OpenAPI and Python tutorial will teach you the fundamentals of Swagger by following this 10-step approach:

      1. PIP install the Flask, Swagger and CORS support dependencies.
      2. Create a simple, RESTful Flask application.
      3. Use Swagger's online editor to document the Flask APIs.
      4. Test your Python APIs online with Swagger UI.
      5. Add Swagger UI support to your Python app.
      6. Test your Python APIs locally with Swagger UI.
      7. Add PUT and POST endpoints to your Flask app.
      8. Further document your APIs with the OpenAPI specification.
      9. Create a Python Flask app with the OpenAPI code generator.
      10. Explore the auto-generated Flask app in VS Code.

A fast, simple and effective way to learn how to use the OpenAPI specification Swagger UI is to create, test and document RESTful APIs written in Python.

Cameron McKenzie has been a Java EE software engineer for 20 years. His current specialties include Agile development; DevOps; Spring; and container-based technologies such as Docker, Swarm and Kubernetes.

View All Videos