Skip to content

Commit

Permalink
Improve and fix docs index page (#1700)
Browse files Browse the repository at this point in the history
Contributes towards #1531 

Improves the high level explanation of Connexion and fixes broken links
on the index page.
  • Loading branch information
RobbeSneyders authored May 9, 2023
1 parent fc1f0df commit ab54842
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
Welcome to Connexion's documentation!
=====================================

Connexion is a spec-first Python web framework that automatically provides functionality based on
an `OpenAPI`_ (or swagger) specification.
Connexion is a Python web framework that makes spec-first and api-first development easy. You
describe your API in an `OpenAPI`_ (or swagger) specification with as much detail as you want and
Connexion will guarantee that it works as you specified.

Connexion Features
------------------
Expand All @@ -29,8 +30,13 @@ Based on your specification, Connexion provides the following functionality:
* Response validation
* A Swagger UI console with live documentation and 'try it out' feature

You are free to describe your REST API with as much detail as you want and
Connexion will guarantee that it works as you specified.
Connexion also helps you write your OpenAPI specification and develop against it by providing a
command line interface which lets you test and mock your specification.

.. code-block:: bash
connexion run openapi.yaml
Why Connexion?
--------------
Expand Down Expand Up @@ -71,10 +77,10 @@ Recommended resources

About the advantages of working spec-first:

* :ref: `Blog Atlassian`
* :ref: `API guidelines Zalando`
* :ref: `Blog ML6`
* :ref: `Blog Zalando`
* `Blog Atlassian`_
* `API guidelines Zalando`_
* `Blog ML6`_
* `Blog Zalando`_

Tools to help you work spec-first:

Expand Down

0 comments on commit ab54842

Please sign in to comment.