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
|
# tornado-swagger
## What is tornado-swagger?
tornado is a wrapper for tornado which enables swagger-ui support.
In essense, you just need to wrap the Api instance and add a few python decorators to get full swagger support.
## How to:
Install:
```
python setup.py install
```
(This installs tornado and epydoc as well)
And in your program, where you'd usually just use tornado, add just a little bit of sauce and get a swagger spec out.
```python
from tornado.web import RequestHandler, HTTPError
from tornado_swagger import swagger
swagger.docs()
# You may decorate your operation with @swagger.operation and use docs to inform information
class ItemNoParamHandler(GenericApiHandler):
@swagger.operation(nickname='create')
def post(self):
"""
@param body: create test results for a pod.
@type body: L{Item}
@return 200: pod is created.
@raise 400: invalid input
"""
# Operations not decorated with @swagger.operation do not get added to the swagger docs
class ItemNoParamHandler(GenericApiHandler):
def options(self):
"""
I'm not visible in the swagger docs
"""
pass
# Then you use swagger.Application instead of tornado.web.Application
# and do other operations as usual
def make_app():
return swagger.Application([
(r"/pods", ItemNoParamHandler),
(r"/pods/([^/]+)", ItemHandler),
(r"/projects/([^/]+)/cases/([^/]+)", ItemOptionParamHandler),
])
# You define models like this:
@swagger.model
class Item:
"""
@descriptin:
This is an example of a model class that has parameters in its constructor
and the fields in the swagger spec are derived from the parameters to __init__.
@notes:
In this case we would have property1, property2 as required parameters and property3 as optional parameter.
@property property3: Item decription
@ptype property3: L{PropertySubclass}
"""
def __init__(self, property1, property2=None):
self.property1 = property1
self.property2 = property2
# Swagger json:
"models": {
"Item": {
"description": "A description...",
"id": "Item",
"required": [
"property1",
],
"properties": [
"property1": {
"type": "string"
},
"property2": {
"type": "string"
"default": null
}
]
}
}
# If you declare an __init__ method with meaningful arguments
# then those args could be used to deduce the swagger model fields.
# just as shown above
# if you declare an @property in docs, this property property2 will also be used to deduce the swagger model fields
class Item:
"""
@property property3: Item description
"""
def __init__(self, property1, property2):
self.property1 = property1
self.property2 = property2
# Swagger json:
"models": {
"Item": {
"description": "A description...",
"id": "Item",
"required": [
"property1",
],
"properties": [
"property1": {
"type": "string"
},
"property2": {
"type": "string"
}
"property3": {
"type": "string"
}
]
}
}
# if you declare an argument with @ptype, the type of this argument will be specified rather than the default 'string'
class Item:
"""
@ptype property3: L{PropertySubclass}
"""
def __init__(self, property1, property2, property3=None):
self.property1 = property1
self.property2 = property2
self.property3 = property3
# Swagger json:
"models": {
"Item": {
"description": "A description...",
"id": "Item",
"required": [
"property1",
],
"properties": [
"property1": {
"type": "string"
},
"property2": {
"type": "string"
},
"property3": {
"type": "PropertySubclass"
"default": null
}
]
}
}
```
# Running and testing
Now run your tornado app
```
python basic.py
```
And visit:
```
curl http://localhost:711/swagger/spec
```
access to web
```
http://localhost:711/swagger/spec.html
```
# Passing more metadata to swagger
customized arguments used in creating the 'swagger.docs' object will be supported later
|
