从flask应用程序的源代码和docstring中提取swagger规范
flask-swagger-plus的Python项目详细描述
#flask swagger plus
从源代码中提取swagger规范(集成了“form”和“schema”组件)。
从棉花糖导入模式中大摇大摆地
字段
class paramsform(form):
email=stringfield()
name=stringfield()
class addressschema(schema):
street=fields.str()
state=fields.str()
country=fields.str()
class userapi(methodview):
@paramsform
@swaggerresponse(addressschema)
defpost(self):
“
创建新用户
--
”“
print(form.email)
print(form.name)
return{
‘street’:‘street’,
‘state’:‘state’,
“country”:“country”
}
app=flask(u name_uu)
>
>
@app.route('/swaggger.json')
despec():
return jsonify(swaggger(app))
>如果有谁在谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁家,谁希望将api导出到swagger规范。
如果您更喜欢使用装饰风格的路由器注册表。
``python
@app.route('/post\u-user')
@paramsform
@swaggerresponse(addressschema)
defepost-user()
“
>create user
>--
”
“
return{}
````
``````/swagger.json`的json结果更喜欢
```
`````
>>>>
“定义”:{
@/>“\u main\u post:addressschema”:{
“properties”:{
“country”:{
“type”:“string”
},
“state”:{
“type”:“string”
},
“street”:{
“type”:“string”
}
}
},
“info”:{
“title”:“酷产品”名称“,
”版本“:”0.0.0”
},
“路径”:{
“/users/”:{
“post”:{
“描述”:,
“参数”:[
{
“描述”:,
“in”:“formdata”,
“名称”:“email”,
“类型”:“string”
},
{
“description”:“,
“in”:“formdata”,
“name”:“name”,
“type”:“string”
}
],
“responses”:{
“200”:{
“description”:“api result”,
“schema”:{
“$ref”:“/definitions/u main_u post:addressschema”
}
}
},
“security”:[],
“summary”:“create a new user”,
“tags”:[
“u main_u”
]
}
}
}
},
“大摇大摆”:“2.0”
}
````
从源代码中提取swagger规范(集成了“form”和“schema”组件)。
从棉花糖导入模式中大摇大摆地
字段
class paramsform(form):
email=stringfield()
name=stringfield()
class addressschema(schema):
street=fields.str()
state=fields.str()
country=fields.str()
class userapi(methodview):
@paramsform
@swaggerresponse(addressschema)
defpost(self):
“
创建新用户
--
”“
print(form.email)
print(form.name)
return{
‘street’:‘street’,
‘state’:‘state’,
“country”:“country”
}
app=flask(u name_uu)
>
>
@app.route('/swaggger.json')
despec():
return jsonify(swaggger(app))
>如果有谁在谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁在谁家,谁家,谁希望将api导出到swagger规范。
如果您更喜欢使用装饰风格的路由器注册表。
``python
@app.route('/post\u-user')
@paramsform
@swaggerresponse(addressschema)
defepost-user()
“
>create user
>--
”
“
return{}
````
``````/swagger.json`的json结果更喜欢
```
`````
>>>>
“定义”:{
@/>“\u main\u post:addressschema”:{
“properties”:{
“country”:{
“type”:“string”
},
“state”:{
“type”:“string”
},
“street”:{
“type”:“string”
}
}
},
“info”:{
“title”:“酷产品”名称“,
”版本“:”0.0.0”
},
“路径”:{
“/users/”:{
“post”:{
“描述”:,
“参数”:[
{
“描述”:,
“in”:“formdata”,
“名称”:“email”,
“类型”:“string”
},
{
“description”:“,
“in”:“formdata”,
“name”:“name”,
“type”:“string”
}
],
“responses”:{
“200”:{
“description”:“api result”,
“schema”:{
“$ref”:“/definitions/u main_u post:addressschema”
}
}
},
“security”:[],
“summary”:“create a new user”,
“tags”:[
“u main_u”
]
}
}
}
},
“大摇大摆”:“2.0”
}
````