1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
|
%global _empty_manifest_terminate_build 0
Name: python-sanic-openapi
Version: 21.12.0
Release: 1
Summary: Easily document your Sanic API with a UI.
License: MIT
URL: http://github.com/sanic-org/sanic-openapi/
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/14/c3/ddfd75ee001957af2a15727a101c476c83a15203ee878f172e8c58a64727/sanic-openapi-21.12.0.tar.gz
BuildArch: noarch
Requires: python3-sanic
Requires: python3-pyyaml
Requires: python3-black
Requires: python3-flake8
Requires: python3-isort
Requires: python3-coverage
Requires: python3-pytest
Requires: python3-pytest-cov
Requires: python3-pytest-html
Requires: python3-pytest-runner
Requires: python3-tox
Requires: python3-recommonmark
Requires: python3-sphinx
Requires: python3-sphinx-rtd-theme
Requires: python3-recommonmark
Requires: python3-sphinx
Requires: python3-sphinx-rtd-theme
Requires: python3-coverage
Requires: python3-pytest
Requires: python3-pytest-cov
Requires: python3-pytest-html
Requires: python3-pytest-runner
Requires: python3-tox
%description
⚠️ This package is being replaced by [Sanic Extensions](https://sanicframework.org/en/plugins/sanic-ext/getting-started.html). The project will continue to be monitored, but no new features or major development is anticipated. Sanic Extensions contains a near 1:1 upgrade if you are using Sanic OpenAPI with OAS3. Ask in the [forums](https://community.sanicframework.org/) or [discord server](https://discord.gg/FARQzAEMAA) for questions about upgrading.
# Sanic OpenAPI
[](https://travis-ci.com/sanic-org/sanic-openapi)
[](https://pypi.python.org/pypi/sanic-openapi/)
[](https://pypi.python.org/pypi/sanic-openapi/)
[](https://github.com/python/black)
[](https://codecov.io/gh/sanic-org/sanic-openapi)
Give your Sanic API a UI and OpenAPI documentation, all for the price of free!
Check out [open collective](https://opencollective.com/sanic-org) to learn more about helping to fund Sanic.
## Installation
```shell
pip install sanic-openapi
```
Add Swagger UI with the OpenAPI spec:
```python
from sanic_openapi import swagger_blueprint
app.blueprint(swagger_blueprint)
```
You'll now have a Swagger UI at the URL `/swagger/` and an OpenAPI 2.0 spec at `/swagger/swagger.json`.
Your routes will be automatically categorized by their blueprints.
## OpenAPI 2
Here is an example to use Sanic-OpenAPI 2:
```python
from sanic import Sanic
from sanic.response import json
from sanic_openapi import openapi2_blueprint
app = Sanic(name="AwesomeApi")
app.blueprint(openapi2_blueprint)
@app.route("/")
async def test(request):
return json({"hello": "world"})
if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
```
And you can get your Swagger document at <http://localhost:8000/swagger> like this:
## OpenAPI 3
Here is an example to use Sanic-OpenAPI 3:
```python
from sanic import Sanic
from sanic.response import json
from sanic_openapi import openapi3_blueprint
app = Sanic(name="AwesomeApi")
app.blueprint(openapi3_blueprint)
@app.route("/")
async def test(request):
return json({"hello": "world"})
if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
```
And you can get your Swagger document at <http://localhost:8000/swagger> like this:
## Documentation
Please check the documentation on [Readthedocs](https://sanic-openapi.readthedocs.io)
## Contribution
Any contribution is welcome. If you don't know how to getting started, please check issues first and check our [Contributing Guide](CONTRIBUTING.md) to start you contribution.
%package -n python3-sanic-openapi
Summary: Easily document your Sanic API with a UI.
Provides: python-sanic-openapi
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-sanic-openapi
⚠️ This package is being replaced by [Sanic Extensions](https://sanicframework.org/en/plugins/sanic-ext/getting-started.html). The project will continue to be monitored, but no new features or major development is anticipated. Sanic Extensions contains a near 1:1 upgrade if you are using Sanic OpenAPI with OAS3. Ask in the [forums](https://community.sanicframework.org/) or [discord server](https://discord.gg/FARQzAEMAA) for questions about upgrading.
# Sanic OpenAPI
[](https://travis-ci.com/sanic-org/sanic-openapi)
[](https://pypi.python.org/pypi/sanic-openapi/)
[](https://pypi.python.org/pypi/sanic-openapi/)
[](https://github.com/python/black)
[](https://codecov.io/gh/sanic-org/sanic-openapi)
Give your Sanic API a UI and OpenAPI documentation, all for the price of free!
Check out [open collective](https://opencollective.com/sanic-org) to learn more about helping to fund Sanic.
## Installation
```shell
pip install sanic-openapi
```
Add Swagger UI with the OpenAPI spec:
```python
from sanic_openapi import swagger_blueprint
app.blueprint(swagger_blueprint)
```
You'll now have a Swagger UI at the URL `/swagger/` and an OpenAPI 2.0 spec at `/swagger/swagger.json`.
Your routes will be automatically categorized by their blueprints.
## OpenAPI 2
Here is an example to use Sanic-OpenAPI 2:
```python
from sanic import Sanic
from sanic.response import json
from sanic_openapi import openapi2_blueprint
app = Sanic(name="AwesomeApi")
app.blueprint(openapi2_blueprint)
@app.route("/")
async def test(request):
return json({"hello": "world"})
if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
```
And you can get your Swagger document at <http://localhost:8000/swagger> like this:
## OpenAPI 3
Here is an example to use Sanic-OpenAPI 3:
```python
from sanic import Sanic
from sanic.response import json
from sanic_openapi import openapi3_blueprint
app = Sanic(name="AwesomeApi")
app.blueprint(openapi3_blueprint)
@app.route("/")
async def test(request):
return json({"hello": "world"})
if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
```
And you can get your Swagger document at <http://localhost:8000/swagger> like this:
## Documentation
Please check the documentation on [Readthedocs](https://sanic-openapi.readthedocs.io)
## Contribution
Any contribution is welcome. If you don't know how to getting started, please check issues first and check our [Contributing Guide](CONTRIBUTING.md) to start you contribution.
%package help
Summary: Development documents and examples for sanic-openapi
Provides: python3-sanic-openapi-doc
%description help
⚠️ This package is being replaced by [Sanic Extensions](https://sanicframework.org/en/plugins/sanic-ext/getting-started.html). The project will continue to be monitored, but no new features or major development is anticipated. Sanic Extensions contains a near 1:1 upgrade if you are using Sanic OpenAPI with OAS3. Ask in the [forums](https://community.sanicframework.org/) or [discord server](https://discord.gg/FARQzAEMAA) for questions about upgrading.
# Sanic OpenAPI
[](https://travis-ci.com/sanic-org/sanic-openapi)
[](https://pypi.python.org/pypi/sanic-openapi/)
[](https://pypi.python.org/pypi/sanic-openapi/)
[](https://github.com/python/black)
[](https://codecov.io/gh/sanic-org/sanic-openapi)
Give your Sanic API a UI and OpenAPI documentation, all for the price of free!
Check out [open collective](https://opencollective.com/sanic-org) to learn more about helping to fund Sanic.
## Installation
```shell
pip install sanic-openapi
```
Add Swagger UI with the OpenAPI spec:
```python
from sanic_openapi import swagger_blueprint
app.blueprint(swagger_blueprint)
```
You'll now have a Swagger UI at the URL `/swagger/` and an OpenAPI 2.0 spec at `/swagger/swagger.json`.
Your routes will be automatically categorized by their blueprints.
## OpenAPI 2
Here is an example to use Sanic-OpenAPI 2:
```python
from sanic import Sanic
from sanic.response import json
from sanic_openapi import openapi2_blueprint
app = Sanic(name="AwesomeApi")
app.blueprint(openapi2_blueprint)
@app.route("/")
async def test(request):
return json({"hello": "world"})
if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
```
And you can get your Swagger document at <http://localhost:8000/swagger> like this:
## OpenAPI 3
Here is an example to use Sanic-OpenAPI 3:
```python
from sanic import Sanic
from sanic.response import json
from sanic_openapi import openapi3_blueprint
app = Sanic(name="AwesomeApi")
app.blueprint(openapi3_blueprint)
@app.route("/")
async def test(request):
return json({"hello": "world"})
if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
```
And you can get your Swagger document at <http://localhost:8000/swagger> like this:
## Documentation
Please check the documentation on [Readthedocs](https://sanic-openapi.readthedocs.io)
## Contribution
Any contribution is welcome. If you don't know how to getting started, please check issues first and check our [Contributing Guide](CONTRIBUTING.md) to start you contribution.
%prep
%autosetup -n sanic-openapi-21.12.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-sanic-openapi -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Sun Apr 23 2023 Python_Bot <Python_Bot@openeuler.org> - 21.12.0-1
- Package Spec generated
|
