利用flasgger生成FlaskAPI文档

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/") 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接口帮助文档

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。