Skip to content

Commit ab54842

Browse files
Improve and fix docs index page (#1700)
Contributes towards #1531 Improves the high level explanation of Connexion and fixes broken links on the index page.
1 parent fc1f0df commit ab54842

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

docs/index.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@
1313
Welcome to Connexion's documentation!
1414
=====================================
1515

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

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

32-
You are free to describe your REST API with as much detail as you want and
33-
Connexion will guarantee that it works as you specified.
33+
Connexion also helps you write your OpenAPI specification and develop against it by providing a
34+
command line interface which lets you test and mock your specification.
35+
36+
.. code-block:: bash
37+
38+
connexion run openapi.yaml
39+
3440
3541
Why Connexion?
3642
--------------
@@ -71,10 +77,10 @@ Recommended resources
7177

7278
About the advantages of working spec-first:
7379

74-
* :ref: `Blog Atlassian`
75-
* :ref: `API guidelines Zalando`
76-
* :ref: `Blog ML6`
77-
* :ref: `Blog Zalando`
80+
* `Blog Atlassian`_
81+
* `API guidelines Zalando`_
82+
* `Blog ML6`_
83+
* `Blog Zalando`_
7884

7985
Tools to help you work spec-first:
8086

0 commit comments

Comments
 (0)