@@ -4,7 +4,7 @@ Integrations
4
4
Bottle
5
5
------
6
6
7
- See `bottle-openapi-3 <https://github.com/cope-systems/bottle-openapi-3 >`_ project.
7
+ See `bottle-openapi-3 <https://github.com/cope-systems/bottle-openapi-3 >`_ project.
8
8
9
9
10
10
Django
@@ -16,7 +16,7 @@ The integration supports Django from version 3.0 and above.
16
16
Middleware
17
17
~~~~~~~~~~
18
18
19
- Django can be integrated by middleware. Add `DjangoOpenAPIMiddleware ` to your `MIDDLEWARE ` list and define `OPENAPI_SPEC `
19
+ Django can be integrated by middleware. Add `DjangoOpenAPIMiddleware ` to your `MIDDLEWARE ` list and define `OPENAPI_SPEC `.
20
20
21
21
.. code-block :: python
22
22
@@ -30,7 +30,7 @@ Django can be integrated by middleware. Add `DjangoOpenAPIMiddleware` to your `M
30
30
31
31
OPENAPI_SPEC = create_spec(spec_dict)
32
32
33
- After that you have access to validation result object with all validated request data from Django view through request object
33
+ After that you have access to validation result object with all validated request data from Django view through request object.
34
34
35
35
.. code-block :: python
36
36
@@ -52,7 +52,7 @@ After that you have access to validation result object with all validated reques
52
52
Low level
53
53
~~~~~~~~~
54
54
55
- For Django you can use DjangoOpenAPIRequest a Django request factory:
55
+ You can use ` DjangoOpenAPIRequest ` as a Django request factory:
56
56
57
57
.. code-block :: python
58
58
@@ -63,7 +63,7 @@ For Django you can use DjangoOpenAPIRequest a Django request factory:
63
63
validator = RequestValidator(spec)
64
64
result = validator.validate(openapi_request)
65
65
66
- You can use DjangoOpenAPIResponse as a Django response factory:
66
+ You can use ` DjangoOpenAPIResponse ` as a Django response factory:
67
67
68
68
.. code-block :: python
69
69
@@ -84,7 +84,7 @@ The integration supports Falcon from version 3.0 and above.
84
84
Middleware
85
85
~~~~~~~~~~
86
86
87
- Falcon API can be integrated by `FalconOpenAPIMiddleware ` middleware.
87
+ The Falcon API can be integrated by `FalconOpenAPIMiddleware ` middleware.
88
88
89
89
.. code-block :: python
90
90
@@ -93,7 +93,7 @@ Falcon API can be integrated by `FalconOpenAPIMiddleware` middleware.
93
93
openapi_middleware = FalconOpenAPIMiddleware.from_spec(spec)
94
94
app = falcon.App(middleware = [openapi_middleware])
95
95
96
- After that you will have access to validation result object with all validated request data from Falcon view through request context
96
+ After that you will have access to validation result object with all validated request data from Falcon view through request context.
97
97
98
98
.. code-block :: python
99
99
@@ -113,7 +113,7 @@ After that you will have access to validation result object with all validated r
113
113
Low level
114
114
~~~~~~~~~
115
115
116
- For Falcon you can use FalconOpenAPIRequest a Falcon request factory:
116
+ You can use ` FalconOpenAPIRequest ` as a Falcon request factory:
117
117
118
118
.. code-block :: python
119
119
@@ -124,7 +124,7 @@ For Falcon you can use FalconOpenAPIRequest a Falcon request factory:
124
124
validator = RequestValidator(spec)
125
125
result = validator.validate(openapi_request)
126
126
127
- You can use FalconOpenAPIResponse as a Falcon response factory:
127
+ You can use ` FalconOpenAPIResponse ` as a Falcon response factory:
128
128
129
129
.. code-block :: python
130
130
@@ -167,7 +167,7 @@ If you want to decorate class based view you can use the decorators attribute:
167
167
View
168
168
~~~~
169
169
170
- As an alternative to the decorator-based integration, Flask method based views can be integrated by inheritance from `FlaskOpenAPIView ` class.
170
+ As an alternative to the decorator-based integration, a Flask method based views can be integrated by inheritance from `FlaskOpenAPIView ` class.
171
171
172
172
.. code-block :: python
173
173
@@ -181,7 +181,7 @@ As an alternative to the decorator-based integration, Flask method based views c
181
181
Request parameters
182
182
~~~~~~~~~~~~~~~~~~
183
183
184
- In Flask, all unmarshalled request data are provided as Flask request object's openapi.parameters attribute
184
+ In Flask, all unmarshalled request data are provided as Flask request object's ` openapi.parameters ` attribute
185
185
186
186
.. code-block :: python
187
187
@@ -196,7 +196,7 @@ In Flask, all unmarshalled request data are provided as Flask request object's o
196
196
Low level
197
197
~~~~~~~~~
198
198
199
- You can use FlaskOpenAPIRequest a Flask/Werkzeug request factory:
199
+ You can use ` FlaskOpenAPIRequest ` as a Flask/Werkzeug request factory:
200
200
201
201
.. code-block :: python
202
202
@@ -207,7 +207,7 @@ You can use FlaskOpenAPIRequest a Flask/Werkzeug request factory:
207
207
validator = RequestValidator(spec)
208
208
result = validator.validate(openapi_request)
209
209
210
- You can use FlaskOpenAPIResponse as a Flask/Werkzeug response factory:
210
+ You can use ` FlaskOpenAPIResponse ` as a Flask/Werkzeug response factory:
211
211
212
212
.. code-block :: python
213
213
@@ -222,7 +222,7 @@ You can use FlaskOpenAPIResponse as a Flask/Werkzeug response factory:
222
222
Pyramid
223
223
-------
224
224
225
- See `pyramid_openapi3 <https://github.com/niteoweb/pyramid_openapi3 >`_ project.
225
+ See `pyramid_openapi3 <https://github.com/niteoweb/pyramid_openapi3 >`_ project.
226
226
227
227
228
228
Requests
@@ -233,7 +233,7 @@ This section describes integration with `Requests <https://requests.readthedocs.
233
233
Low level
234
234
~~~~~~~~~
235
235
236
- For Requests you can use RequestsOpenAPIRequest a Requests request factory:
236
+ You can use ` RequestsOpenAPIRequest ` as a Requests request factory:
237
237
238
238
.. code-block :: python
239
239
@@ -244,7 +244,7 @@ For Requests you can use RequestsOpenAPIRequest a Requests request factory:
244
244
validator = RequestValidator(spec)
245
245
result = validator.validate(openapi_request)
246
246
247
- You can use RequestsOpenAPIResponse as a Requests response factory:
247
+ You can use ` RequestsOpenAPIResponse ` as a Requests response factory:
248
248
249
249
.. code-block :: python
250
250
@@ -258,4 +258,4 @@ You can use RequestsOpenAPIResponse as a Requests response factory:
258
258
Tornado
259
259
-------
260
260
261
- See `tornado-openapi3 <https://github.com/correl/tornado-openapi3 >`_ project.
261
+ See `tornado-openapi3 <https://github.com/correl/tornado-openapi3 >`_ project.
0 commit comments