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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
%global _empty_manifest_terminate_build 0
Name: python-django-openapi
Version: 0.1.1.11
Release: 1
Summary: A minimal FastAPI implementation in python2 + Django without pydantic
License: MIT License
URL: https://github.com/tokikanno/django-openapi
Source0: https://mirrors.aliyun.com/pypi/web/packages/3e/10/de2b06156083d22a531e602d9b9508ebaa7019baea5a71a1c5246791ce4f/django-openapi-0.1.1.11.tar.gz
BuildArch: noarch
Requires: python3-django
Requires: python3-six
%description
# django-openapi
A minimal FastAPI implementation in Python2 + Django without pydantic
# Why do you make this? Can't you just use FastAPI directly?
I'm a big fan of [FastAPI](https://fastapi.tiangolo.com/). It's elegant and saves lots of doc maintaince & API spec communication costs for me.
But FastAPI needs Python3 to run, some legacy projects I maintained are still using Python2 and built by Django framework. It would take 2 migration steps (Python 2 to 3 and Django to FastAPI) for moving them onto FastAPI framework.
So I decided to build a minimal FastAPI implementation in Python2 + Django, that I could instantly get the benefits from FastAPI without too many migrations on my legacy projects.
# Who should use this?
People who like the way FastAPI works but
* Are still on the long migration process from Python2 to Python3
* Or don't want to do full system rewrite from Django to FastAPI
* Or don't want to upgrade from Python2 to Python3
# Features
* Auto OpenAPI schema/document generation from Python function parameter
* Auto HTTP request parameter validation from Python function parameters
* Python 2/3 compatiable, you could use almost the same code for you Python2/3 projects
# Installation
```
pip install django-openapi
```
# Live demo provided by Gitpod
Click the button below and launch a free live demo server via Gitpod
[](https://gitpod.io/#https://github.com/tokikanno/django-openapi)
If the button doesn't show up, you clould also use below link directly
[https://gitpod.io/#https://github.com/tokikanno/django-openapi](https://gitpod.io/#https://github.com/tokikanno/django-openapi)
After Gitpod launched, if you see a dialog like this, just hit the `Open Browser` button then you will get to the quick intro live demo server.
Use ctrl + p (or cmd + p if u're using MacOS X) and search for `intro.py` to see the source code of intro demo server.
# Quick start
### In your Django project
* Import `OpenAPI` from `django_openapi`
* Create an API object instance
* Add API object into urlpatterns
```python
# import OpenAPI from django_opeanapi
from django_openapi import OpenAPI
# create an API object instance
api = OpenAPI(title='My OpenAPI Test', prefix_path='/test_api')
urlpatterns = [
api.as_django_url_pattern() # Add API object into urlpatterns
]
```
* Start you django debug server and open your browser with url like `http://localhost:8000/test_api/_docs`, this is the auto document page.
* Now let's try adding some basic routes for you API
```python
from django_openapi import Path, Query, Form
@api.get('/test/hello_via_path/{word}', tags=['test'])
def hello_via_path(word=Path()):
return {'hello': word}
@api.get('/test/hello_via_query', tags=['test'])
def hello_via_query(word=Query()):
return {'hello': word}
@api.post('/test/hello_via_form', tags=['test'])
def hello_via_form(word=Form()):
return {'hello': word}
```
* Reload your browser & see if anything changed to the auto document page
* Advanced routes via JSON body & JSON schema object
```python
from django_openapi import Body
from django_openapi.schema import BaseModel, StringField
class HelloPayload(BaseModel):
word = StringField(default_value='world', min_length=3)
@api.post('/test/hello_via_json_body', tags=['test'])
def hello_via_json_body(payload=Body(HelloPayload)):
return {'hello': payload.word}
```
* Reload agagin, the auto document page now should have 4 APIs on it.
Browse to the [demo folder](https://github.com/tokikanno/django-openapi/tree/master/demo) for more advanced samples.
# TODO
* More documents and samples
* Better schema validation error message handling
* More advanced field types (e.g.: EmailStringField, CommaSeparatedArrayField ...)
%package -n python3-django-openapi
Summary: A minimal FastAPI implementation in python2 + Django without pydantic
Provides: python-django-openapi
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-django-openapi
# django-openapi
A minimal FastAPI implementation in Python2 + Django without pydantic
# Why do you make this? Can't you just use FastAPI directly?
I'm a big fan of [FastAPI](https://fastapi.tiangolo.com/). It's elegant and saves lots of doc maintaince & API spec communication costs for me.
But FastAPI needs Python3 to run, some legacy projects I maintained are still using Python2 and built by Django framework. It would take 2 migration steps (Python 2 to 3 and Django to FastAPI) for moving them onto FastAPI framework.
So I decided to build a minimal FastAPI implementation in Python2 + Django, that I could instantly get the benefits from FastAPI without too many migrations on my legacy projects.
# Who should use this?
People who like the way FastAPI works but
* Are still on the long migration process from Python2 to Python3
* Or don't want to do full system rewrite from Django to FastAPI
* Or don't want to upgrade from Python2 to Python3
# Features
* Auto OpenAPI schema/document generation from Python function parameter
* Auto HTTP request parameter validation from Python function parameters
* Python 2/3 compatiable, you could use almost the same code for you Python2/3 projects
# Installation
```
pip install django-openapi
```
# Live demo provided by Gitpod
Click the button below and launch a free live demo server via Gitpod
[](https://gitpod.io/#https://github.com/tokikanno/django-openapi)
If the button doesn't show up, you clould also use below link directly
[https://gitpod.io/#https://github.com/tokikanno/django-openapi](https://gitpod.io/#https://github.com/tokikanno/django-openapi)
After Gitpod launched, if you see a dialog like this, just hit the `Open Browser` button then you will get to the quick intro live demo server.
Use ctrl + p (or cmd + p if u're using MacOS X) and search for `intro.py` to see the source code of intro demo server.
# Quick start
### In your Django project
* Import `OpenAPI` from `django_openapi`
* Create an API object instance
* Add API object into urlpatterns
```python
# import OpenAPI from django_opeanapi
from django_openapi import OpenAPI
# create an API object instance
api = OpenAPI(title='My OpenAPI Test', prefix_path='/test_api')
urlpatterns = [
api.as_django_url_pattern() # Add API object into urlpatterns
]
```
* Start you django debug server and open your browser with url like `http://localhost:8000/test_api/_docs`, this is the auto document page.
* Now let's try adding some basic routes for you API
```python
from django_openapi import Path, Query, Form
@api.get('/test/hello_via_path/{word}', tags=['test'])
def hello_via_path(word=Path()):
return {'hello': word}
@api.get('/test/hello_via_query', tags=['test'])
def hello_via_query(word=Query()):
return {'hello': word}
@api.post('/test/hello_via_form', tags=['test'])
def hello_via_form(word=Form()):
return {'hello': word}
```
* Reload your browser & see if anything changed to the auto document page
* Advanced routes via JSON body & JSON schema object
```python
from django_openapi import Body
from django_openapi.schema import BaseModel, StringField
class HelloPayload(BaseModel):
word = StringField(default_value='world', min_length=3)
@api.post('/test/hello_via_json_body', tags=['test'])
def hello_via_json_body(payload=Body(HelloPayload)):
return {'hello': payload.word}
```
* Reload agagin, the auto document page now should have 4 APIs on it.
Browse to the [demo folder](https://github.com/tokikanno/django-openapi/tree/master/demo) for more advanced samples.
# TODO
* More documents and samples
* Better schema validation error message handling
* More advanced field types (e.g.: EmailStringField, CommaSeparatedArrayField ...)
%package help
Summary: Development documents and examples for django-openapi
Provides: python3-django-openapi-doc
%description help
# django-openapi
A minimal FastAPI implementation in Python2 + Django without pydantic
# Why do you make this? Can't you just use FastAPI directly?
I'm a big fan of [FastAPI](https://fastapi.tiangolo.com/). It's elegant and saves lots of doc maintaince & API spec communication costs for me.
But FastAPI needs Python3 to run, some legacy projects I maintained are still using Python2 and built by Django framework. It would take 2 migration steps (Python 2 to 3 and Django to FastAPI) for moving them onto FastAPI framework.
So I decided to build a minimal FastAPI implementation in Python2 + Django, that I could instantly get the benefits from FastAPI without too many migrations on my legacy projects.
# Who should use this?
People who like the way FastAPI works but
* Are still on the long migration process from Python2 to Python3
* Or don't want to do full system rewrite from Django to FastAPI
* Or don't want to upgrade from Python2 to Python3
# Features
* Auto OpenAPI schema/document generation from Python function parameter
* Auto HTTP request parameter validation from Python function parameters
* Python 2/3 compatiable, you could use almost the same code for you Python2/3 projects
# Installation
```
pip install django-openapi
```
# Live demo provided by Gitpod
Click the button below and launch a free live demo server via Gitpod
[](https://gitpod.io/#https://github.com/tokikanno/django-openapi)
If the button doesn't show up, you clould also use below link directly
[https://gitpod.io/#https://github.com/tokikanno/django-openapi](https://gitpod.io/#https://github.com/tokikanno/django-openapi)
After Gitpod launched, if you see a dialog like this, just hit the `Open Browser` button then you will get to the quick intro live demo server.
Use ctrl + p (or cmd + p if u're using MacOS X) and search for `intro.py` to see the source code of intro demo server.
# Quick start
### In your Django project
* Import `OpenAPI` from `django_openapi`
* Create an API object instance
* Add API object into urlpatterns
```python
# import OpenAPI from django_opeanapi
from django_openapi import OpenAPI
# create an API object instance
api = OpenAPI(title='My OpenAPI Test', prefix_path='/test_api')
urlpatterns = [
api.as_django_url_pattern() # Add API object into urlpatterns
]
```
* Start you django debug server and open your browser with url like `http://localhost:8000/test_api/_docs`, this is the auto document page.
* Now let's try adding some basic routes for you API
```python
from django_openapi import Path, Query, Form
@api.get('/test/hello_via_path/{word}', tags=['test'])
def hello_via_path(word=Path()):
return {'hello': word}
@api.get('/test/hello_via_query', tags=['test'])
def hello_via_query(word=Query()):
return {'hello': word}
@api.post('/test/hello_via_form', tags=['test'])
def hello_via_form(word=Form()):
return {'hello': word}
```
* Reload your browser & see if anything changed to the auto document page
* Advanced routes via JSON body & JSON schema object
```python
from django_openapi import Body
from django_openapi.schema import BaseModel, StringField
class HelloPayload(BaseModel):
word = StringField(default_value='world', min_length=3)
@api.post('/test/hello_via_json_body', tags=['test'])
def hello_via_json_body(payload=Body(HelloPayload)):
return {'hello': payload.word}
```
* Reload agagin, the auto document page now should have 4 APIs on it.
Browse to the [demo folder](https://github.com/tokikanno/django-openapi/tree/master/demo) for more advanced samples.
# TODO
* More documents and samples
* Better schema validation error message handling
* More advanced field types (e.g.: EmailStringField, CommaSeparatedArrayField ...)
%prep
%autosetup -n django-openapi-0.1.1.11
%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-django-openapi -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.1.1.11-1
- Package Spec generated
|
