利用flasgger生成FlaskAPI文档

举报
彭世瑜 发表于 2021/08/14 00:44:03 2021/08/14
【摘要】 github:https://github.com/flasgger/flasgger 安装 pip install flasgger 1 示例 # -*- coding: utf-8 -*- from flask import Flask, jsonify from flasgger import Swagger app = Flask(__name__) ...

github:https://github.com/flasgger/flasgger

安装

pip install flasgger

  
 
  • 1

示例

# -*- coding: utf-8 -*-
from flask import Flask, jsonify
from flasgger import Swagger

app = Flask(__name__)
swagger = Swagger(app)


@app.route("/getInfo/<int:uid>")
def get_info(uid): """获取用户信息 --- parameters: - name: uid in: path type: int required: true default: 1 description: 用户id responses: 200: description: 返回用户信息 examples: { code: 0, msg: "ok", data: { name: "Tom", uid: 1 }, } """ data = { "code": 0, "msg": "ok", "data": { "name": "Tom", "uid": uid } } return jsonify(data)


if __name__ == '__main__': app.run(debug=True)


  
 
  • 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

http://127.0.0.1:5000/apidocs/
访问文档
在这里插入图片描述

参考:
利用swagger模块开发flask的api接口帮助文档

文章来源: pengshiyu.blog.csdn.net,作者:彭世瑜,版权归原作者所有,如需转载,请联系作者。

原文链接:pengshiyu.blog.csdn.net/article/details/102767046

【版权声明】本文为华为云社区用户转载文章,如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。