Skip to content

Commit

Permalink
Add 3.0 announcement (#1774)
Browse files Browse the repository at this point in the history
Final update for the 3.0 announcement on our docs.
  • Loading branch information
RobbeSneyders authored Nov 2, 2023
1 parent f2ee190 commit d972eae
Showing 1 changed file with 38 additions and 17 deletions.
55 changes: 38 additions & 17 deletions docs/v3.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,48 @@
Getting started with Connexion 3.0
==================================
Connexion 3.0: API-first for all
================================

Connexion 3.0 brings some major changes compared to 2.X:
**We are excited to announce the release of Connexion 3.0!** 🎉

* Connexion can now be used as middleware to supercharge any ASGI or WSGI compatible framework.
* Aiohttp support has been dropped in favor of an ASGI compatible ``AsyncApp`` built on top of Starlette.
* Connexion functionality is now pluggable by adding or removing middleware.
* Validation is now pluggable by content type, solving longstanding issues regarding endpoints with
multiple content types and providing a pluggable interface.
Connexion 3 fundamentally changes how Connexion is designed and implemented, and how it
fits into the wider Python API ecosystem. We adopted the ASGI interface, which makes Connexion both
modular and well-integrated with most modern Python API tooling.

Install Connexion 3
---------------------
**It brings some major changes compared to 2.X:**

Install the latest version using
* The improved ``App`` and new ``AsyncApp`` allow you to use Connexion as a stand-alone framework

.. code-block:: bash
* The ``App`` interface was extended so you no longer have to care about the framework used
underneath

* Connexion can now be used as middleware to supercharge any ASGI or WSGI-compatible framework
with its spec-based functionality
* Connexion is now pluggable in many dimensions:

* All Connexion functionality is pluggable by adding or removing middleware from its stack
* Validation is now pluggable by content type, solving longstanding issues regarding endpoints
with multiple content types and making it easy to add validation for additional content types
* Authentication is now pluggable by security scheme, making it easy to customize the behavior or
add support for additional security schemes.

* Aiohttp support has been dropped due to lack of ASGI support
* We spent a lot of effort on extending and improving `our documentation`_

pip install connexion
**Read on below to discover more changes.** 👇

.. note::
Or read our `in-depth blog post`_ on the redesign.

Connexion 3 will be released on 02/11/23. Until then, you can add the `--pre` flag to install
a pre-release version.
.. _in-depth blog post: https://medium.com/@robbe.sneyders/a5dc17e81ff8?source=friends_link&sk=de5a7a67ccae8a03752f5e8e1dc68d48
.. _our documentation: https://connexion.readthedocs.io/en/stable/

Getting started with Connexion 3
--------------------------------

Using stand-alone Connexion
---------------------------

You can use Connexion as a stand-alone web framework, using one of the available apps:

* The ``FlaskApp``, which is built on top of Flask as known from Connexion 2.X.
* The ``App`` (alias ``FlaskApp``), which is built on top of Flask as known from Connexion 2.X.
* The ``AsyncApp``, which is built on top of starlette and provides native asynchronous functionality.

If you don't require compatibility with the Flask ecosystem, we recommend to use the ``AsyncApp``.
Expand Down Expand Up @@ -139,6 +153,13 @@ Non-breaking changes
* Connexion now provides a ``DefaultsJSONRequestBodyValidator`` to fill in default values in received
request bodies.

Full changelog
--------------

Consult our `Github release page`_ for an overview of all changes.

.. _Github release page: https://github.com/spec-first/connexion/releases/tag/3.0.0

Feedback
--------

Expand Down

0 comments on commit d972eae

Please sign in to comment.