黑松山资源网 Design By www.paidiu.com
使用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.接口文档页面效果
以上这篇使用apidoc管理RESTful风格Flask项目接口文档方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持。
黑松山资源网 Design By www.paidiu.com
广告合作:本站广告合作请联系QQ:858582 申请时备注:广告合作(否则不回)
免责声明:本站资源来自互联网收集,仅供用于学习和交流,请遵循相关法律法规,本站一切资源不代表本站立场,如有侵权、后门、不妥请联系本站删除!
免责声明:本站资源来自互联网收集,仅供用于学习和交流,请遵循相关法律法规,本站一切资源不代表本站立场,如有侵权、后门、不妥请联系本站删除!
黑松山资源网 Design By www.paidiu.com
暂无评论...
稳了!魔兽国服回归的3条重磅消息!官宣时间再确认!
昨天有一位朋友在大神群里分享,自己亚服账号被封号之后居然弹出了国服的封号信息对话框。
这里面让他访问的是一个国服的战网网址,com.cn和后面的zh都非常明白地表明这就是国服战网。
而他在复制这个网址并且进行登录之后,确实是网易的网址,也就是我们熟悉的停服之后国服发布的暴雪游戏产品运营到期开放退款的说明。这是一件比较奇怪的事情,因为以前都没有出现这样的情况,现在突然提示跳转到国服战网的网址,是不是说明了简体中文客户端已经开始进行更新了呢?
更新日志
2024年10月08日
2024年10月08日
- 郭子.2001-原来你什么都不想要创作集丫滚石】【WAV+CUE】
- 《使命召唤:黑色行动6》新预告公布!10月25日发售
- Atlus《暗喻幻想》媒体评分汇总:高分好评如潮!
- 2024金摇杆奖提名揭晓 《黑神话》角逐最佳视觉设计!
- 群星《新说唱2024 第3期 (上)》[320K/MP3][32.76MB]
- 群星《新说唱2024 第3期 (上)》[FLAC/分轨][95.38MB]
- 群星《新说唱2024 第3期 (下)》[320K/MP3][31.36MB]
- 幻兽帕鲁手游什么时候正式上线 最新消息一览
- 西普大陆BOSS位置盘点 解锁天启纪元玩法
- 西普大陆精灵进阶培养攻略 精灵养成指南
- dnf手游法控法系职业哪个强 dnf手游法控法系职业强度排行
- 魔兽世界血藤护目镜图纸在哪买 wlk血藤护目镜图纸购买位置介绍
- 魔兽世界无畏远征军声望军需官在哪 wlk无畏远征军声望军需官坐标位置
- 逼迫中国选手弃权事件持续发酵 玩家抵制万代模型
- B社老员工在《星空》开发期间离职 他终于说出原因