File tree 1 file changed +14
-8
lines changed
1 file changed +14
-8
lines changed Original file line number Diff line number Diff line change 13
13
Welcome to Connexion's documentation!
14
14
=====================================
15
15
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.
18
19
19
20
Connexion Features
20
21
------------------
@@ -29,8 +30,13 @@ Based on your specification, Connexion provides the following functionality:
29
30
* Response validation
30
31
* A Swagger UI console with live documentation and 'try it out' feature
31
32
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
+
34
40
35
41
Why Connexion?
36
42
--------------
@@ -71,10 +77,10 @@ Recommended resources
71
77
72
78
About the advantages of working spec-first:
73
79
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 `_
78
84
79
85
Tools to help you work spec-first:
80
86
You can’t perform that action at this time.
0 commit comments