Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve and fix docs index page #1700

Merged
merged 3 commits into from
May 9, 2023
Merged

Improve and fix docs index page #1700

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4acaf12
Fix links on docs index page
RobbeSneyders Apr 29, 2023
31c8a17
Rewrite connexion elevator pitch
RobbeSneyders Apr 29, 2023
09be38a
Add cli to features on index docs
RobbeSneyders Apr 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions docs/index.rst
View file
Open in desktop
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