使用apidoc管理RESTful风格Flask项目接口文档方法
作者:lynnyq 发布时间:2022-11-24 10:05:14
标签:apidoc,RESTful,Flask,接口文档
使用apidoc管理RESTful风格Flask项目接口文档方法
apidoc项目地址
flask扩展包地址
文档示例地址
1.安装nodejs
sudo apt-get install nodejs
sudo apt install nodejs-legacy
sudo apt install npm
2.安装apidoc
npm install apidoc -g
3.Flask扩展包安装
pip install flask-apidoc
4.添加扩展包到Flask项目
依赖环境
flask>=0.10.1
flask_script>=2.0.5
manage.py项目启动脚本配置
from views import app
from flask_apidoc.commands import GenerateApiDoc
from flask_script import Manager
manager = Manager(app)
manager.add_command('apidoc', GenerateApiDoc())
if __name__ == "__main__":
manager.run()
apidoc.json配置
必须在项目根目录下建立apidoc.json配置文件
{
"name": "Flask REST API",
"version": "1.0.0",
"description": "A Flask REST API example",
"title": "A Flask REST API example",
"url" : "http://localhost:5000"
}
视图函数文档注释说明示例
# -*- coding: utf-8 -*-
from flask import Flask
from flask_apidoc import ApiDoc
app = Flask(__name__)
doc = ApiDoc(app=app)
@app.route('/users', methods=['POST'])
def register():
"""
@api {post} /api/v1.0/users 注册
@apiVersion 1.0.0
@apiName register_user
@apiGroup Users
@apiParam {String} mobile (必须) 用户手机号
@apiParam {String} password (必须) 用户密码
@apiParam {String} sms_code (必须) 用户短信验证码
@apiParamExample {json} Request-Example:
{
mobile: "13970512239",
password: "123456",
sms_code: "907896"
}
@apiSuccess (回参) {int} user_id 用户注册id
@apiSuccess (回参) {String} name 用户昵称
@apiSuccess (回参) {String} mobile 用户注册手机号
@apiSuccess (回参) {String} avatar 用户头像地址
@apiSuccess (回参) {String} create_time 用户创建时间
@apiSuccessExample {json} Success-Response:
{
"errno":0,
"errmsg":"注册成功!",
"data": {
"user_id": 1,
"name": "lynnyq",
"mobile": "13813888888",
"avatar": "http://p3ifu3dwc.bkt.clouddn.com/FjuAwxmcCtiud_nOZ",
"create_time": "2010-1-1 12:12:12"
}
}
@apiErrorExample {json} Error-Response:
{
"errno":4001,
"errmsg":"数据库查询错误!"
}
"""
pass
5.生成RESTful风格接口文档
python manage.py apidoc
文档默认生成在项目根目录下的static/docs文件夹下
6.接口文档页面效果
来源:http://blog.csdn.net/lynnyq/article/details/79254290
0
投稿
猜你喜欢
- 清除视图缓存,就是清除D:\phpStudy\WWW\BCCKidV1.0\storage\framework\views\002f30b1
- 在php中获取数组长度方法很简单,php为我们提供了两个函数可以计算一维数组长度,如count,sizeof都可以直接统计数组长度哦,下面我
- 网页编程中,在与数据库打交道的时候我们经常会碰到乱码的经常。本文就将介绍一种ASP读取MySQL数据库出现乱码的解决办法。情景再现:使用My
- 网页设计中,内容组织恐怕是最至关重要、最影响设计品质的方面了。如何将信息组织到好的布局中,是一个网站的基础,并且应该在考虑外观之前就决定好。
- 1.首先主题选择不要落俗!现在许多的个人主页就象“大锅饭”。题材包罗万象,内容雷同无味。人人都是“软件速递”“音乐宝库”“主页教程”等等。让
- 代码都比较容易理解的,主要就是在以16进制读取图片信息那段代码有点乱,其实仔细看看,也没什么的。glabal.cssbody{}{ &nbs
- 一、弹窗事件是什么?弹窗事件就是在我们执行某操作的时候,弹出信息框给出提示。或收集数据的时候,弹出窗口收集信息,不想收集可以取消隐藏。二、简
- 简介模板方法模式,是行为型的设计模式。定义一个操作中的算法的骨架,而将一些步骤延迟到子类当中,使得子类可以不改变一个算法的结构即可重新定义该
- 目前是把图片存在mongodb数据库,实现一个方法,比如 访问 /get_pic/ID 能实现图片在浏览器打开,添加了一个状态,比如?fil
- 在网上我们常常看见一些注册表单的输入框部分并不是我们常见的矩形框,而是一条细线,很多朋友对此很感兴趣。其实要实现这样的效果并不困难,我们只要
- rem ---表单提示函数 Being-----------------------------CODE Copy ... Fu
- access中可以将文本中的数据轻松导入表中,mysql中用起来没那么方便,其实起来也很简单。首先将数据记录按行处理好用特定的字符分开如:“
- MySQL插件式存储引擎是MySQL数据库服务器中的组件,负责为数据库执行实际的数据I/O操作,并能允许和强制执行面向特殊应用需求的特定特性
- 任意给出一个数,求该数以内的所有质数.(使用筛选法做的)先看看什么叫做质数?质数的定义:一个大于1的自然数,除了1与它自身外,再没有其它的正
- 概要:Oracle关系数据库系统以其卓越的性能获得了广泛的应用,而保证数据库的安全性 是数据库管理工作的重要内容。本文是笔者在总结Oracl
- PHP作为开源语言,发展至今已有很多成熟的国内外开源系统,足以满足个人和企业用户自己建立WEB站点,下面则主要介绍PHP建站的流程和步骤。不
- 在Python 2.7中,一个float的repr返回最接近十七位数的十进制数;这足以精确地识别每个可能的IEEE浮点值.浮点数的str类似
- 前言:我目前使用的服务器为centos6.x 系统自带的python的版本为2.6.x,但是目前无论是学习还是使用python,python
- 今天也碰到了el表达式无法解析的事情,于是在网上查询了下,大多说是因为web.xml中声明的版本问题于是收集了如下版本:web-app_2_
- 昨天有位同事说,他的网页查询过程中发现普通索引和唯一索引的效率是有差别的,普通索引比唯一索引快,今天在我的虚拟机中布置了环境,测试抓图如下: