Skip to content

Latest commit

 

History

History
36 lines (29 loc) · 1.31 KB

index.rst

File metadata and controls

36 lines (29 loc) · 1.31 KB

Welcome to Connexion's documentation!

Connexion is a framework on top of Flask that automagically handles HTTP requests based on OpenAPI 2.0 Specification (formerly known as Swagger Spec) of your API described in YAML format. Connexion allows you to write a Swagger specification and then maps the endpoints to your Python functions. This is what makes it unique from other tools that generate the specification based on your Python code. You are free to describe your REST API with as much detail as you want and then Connexion guarantees that it will work as you specified. We built Connexion this way in order to:

  • Simplify the development process
  • Reduce misinterpretation about what an API is going to look like

Contents:

.. toctree::
   :maxdepth: 2

   quickstart
   routing
   request
   response
   security
   cookbook