Swagger Api Generation for Flask-Mongorest
Flask-MongoRest-Swagger的Python项目详细描述
Flask Mongorest Swagger
=========
Flask Mongorest的Swagger API生成
example
----
rest API=Mongorest（app）
swagger=Swagger（rest API）
Class APIResource（mongorest.resource）：
document=documentClass
parameters={
“额外参数”：参数（'query'，'string'，
'does something else'）}
@swagger.register（url='/api endpoint'）
类apiview（resourceview）：
resource=apirource
@swagger.route（
'/api function'，methods=['post']，
description='此API视图的说明'，
终结点=[终结点（
终结点（
'/API函数/'，
登录描述，
操作=[操作（
'发布'，'函数'，'更多说明！'，
响应“token”，
参数={
“data”：参数（
“body”，“input”，“whatever you need to pass in”，
必需=true）}，
错误响应={401:“无效电子邮件/密码”}），
models={
“input”：model（'input'，{
“input廑string”：property（'string'，'input to the function'）}）、
“token”：model（'token'，{
“token”：property（
“string”，“the token which cours'）}）
def api廑function（）：
return“谢谢！”
这将生成一个可在<；http://localhost:5000/api docs.json>；上使用的招摇api
-
*swagger<；https://developers.helloreverb.com/swagger/>；
*flask<；http://flask.pocoo.org/>；
*flask mongorest<；https://github.com/elasticsales/flask mongorest>；
*matchbox<；http://matchbox.net/>；
=========
Flask Mongorest的Swagger API生成
example
----
rest API=Mongorest（app）
swagger=Swagger（rest API）
Class APIResource（mongorest.resource）：
document=documentClass
parameters={
“额外参数”：参数（'query'，'string'，
'does something else'）}
@swagger.register（url='/api endpoint'）
类apiview（resourceview）：
resource=apirource
@swagger.route（
'/api function'，methods=['post']，
description='此API视图的说明'，
终结点=[终结点（
终结点（
'/API函数/'，
登录描述，
操作=[操作（
'发布'，'函数'，'更多说明！'，
响应“token”，
参数={
“data”：参数（
“body”，“input”，“whatever you need to pass in”，
必需=true）}，
错误响应={401:“无效电子邮件/密码”}），
models={
“input”：model（'input'，{
“input廑string”：property（'string'，'input to the function'）}）、
“token”：model（'token'，{
“token”：property（
“string”，“the token which cours'）}）
def api廑function（）：
return“谢谢！”
这将生成一个可在<；http://localhost:5000/api docs.json>；上使用的招摇api
-
*swagger<；https://developers.helloreverb.com/swagger/>；
*flask<；http://flask.pocoo.org/>；
*flask mongorest<；https://github.com/elasticsales/flask mongorest>；
*matchbox<；http://matchbox.net/>；
欢迎加入QQ群-->： 979659372
