Flask+Nodejs开发Restful风格接口文档

最新推荐文章于 2025-03-03 09:03:02 发布
最新推荐文章于 2025-03-03 09:03:02 发布
阅读量3.8k 收藏 3
点赞数 2
CC 4.0 BY-SA版权
分类专栏： # Flask 文章标签： flask restful 接口文档
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/Xin_101/article/details/88121486
本文介绍如何使用Flask生成API接口文档，并通过Node.js服务进行前端部署，实现线上API文档的访问。包括环境搭建、API文档生成、Node.js服务部署等关键步骤。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

1 环境及部署

1.0 基础环境

  • Ubuntu18.04
  • Flask
  • flask-apidoc
  • flask-script
  • flask-cors
  • nodejs
  • npm(nodejs包管理)

1.2 运行环境

  • body-parser1.18.2
  • cookie-parser1.4.3
  • debug2.6.9
  • ejs2.5.7
  • express4.15.5
  • morgan1.9.0
  • serve-favicon2.4.5
  • pm2

1.3 环境部署

  • nodejs环境
sudo apt-get install nodejs
sudo apt install npm
sudo npm install apidoc -g
sudo cpm pm2
sudo cnpm i
  • flask环境
pip3 install flask
pip3 install flask-script
pip3 install flask-apidoc
pip3 install flask-cors

2 生成API接口文档

2.1 flask文件结构

|-- api_doc_flask
|   |-- __pycache__
|   |   `-- views.cpython-36.pyc
|   |-- apidoc.json
|   |-- run.py
|   `-- views.py

2.2 文件内容

2.2.1 apidoc.json

API文档说明.

{
 "name": "REST API",
 "version": "1.0.0",
 "description": "REST API show",
 "title": "REST API",
 // URI前缀,若使用多个port可忽略url
 // 直接在{get}或{post}添加URI即可
 "url" : "http://localhost:8090"
}

2.2.2 views.py

API接口结构内容,写在route中,每个route代表一个接口,和flask接口模式相同.

from flask import Flask, render_template 
from flask_apidoc import ApiDoc 

app = Flask(__name__)

doc = ApiDoc(app=app)

@app.route('/post', methods=['POST', 'GET'])
def register():
	"""
	@api {post} http://localhost:8090/api/v1.0/register 注册 
	@apiVersion 1.0.0
	@apiName register_user
	@apiGroup Users 
	@apiParam {String} mobile (必须)用户手机号
	@apiParam {String} password (必须)用户密码
	@apiParam {String}sms_code (必须)用户短信验证码
	@apiParamExample {json} 请求样例json:
	{
		"mobile": "123456",
		"password": "123456",
		"sms_code": "123456"
	}
	@apiSuccess (回参) {int} user_id 用户注册id
	@apiSuccess (回参) {String} name 用户昵称
	@apiSuccess (回参) {String} mobile 用户注册手机号
	@apiSuccess (回参) {String} avatar 用户头像地址
	@apiSuccess (回参) {String} create_time 用户创建时间
	@apiSuccessExample {json} 请求成功:
	{
		"errno":0,
		"errmsg":"注册成功",
		"data":{
			"user_id":250,
			"name":"tianlanlan",
			"mobile":"123456",
			"avatar":"http://www.test.com",
			"create_time":"2019"
		}
	}
	@apiErrorExample {json} 请求异常:
	{
		"errno":250,
		"errmsg":"数据库查询错误"
	}
	"""
	pass

@app.route('/get', methods=['POST'])
def get_test():
	"""
	@api {get} http://localhost:8091/api/v1.0/connect 连接测试
	@apiVersion 1.0.0
	@apiGroup Connect
	@apiParam {String} id (必须)用户ID
	@apiParamExample {form-data} 请求样例form-data:
	id = 250
	@apiSuccess (返回参数) {String} info 连接状态
	@apiSuccessExample {json} 请求成功:
	{
		"errno":200,
		"errmsg":"请求成功",
		"data":{
			"info":"Successfully connection!"
		}
	}
	@apiErrorExample {json} 请求异常:
	{
		"errno":250,
		"errmsg":"连接异常"
	}
	"""
	pass

2.2.3 run.py

运行服务生成API接口文档文件.

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()
  • 运行命令
python run.py apidoc

2.2.4 static接口文件

生成接口文档,目录如下:

|-- static
|   |   `-- docs
|   |       |-- api_data.js
|   |       |-- api_data.json
|   |       |-- api_project.js
|   |       |-- api_project.json
|   |       |-- css
|   |       |-- fonts
|   |       |-- img
|   |       |-- index.html
|   |       |-- locales
|   |       |-- main.js
|   |       |-- utils
|   |       `-- vendor

其中index.html为API接口界面,直接可浏览器打开,其他文件为js和css等辅助文件.

3 Nodejs部署服务

3.1 批量安装依赖

node文件结构:

|-- nodeServer
|   |-- app.js
|   |-- bin
|   |   `-- www
|   |-- node_modules [error opening dir]
|   |-- nodeserver.sh
|   |-- package.json
|   |-- public
|   |   |-- api_data.js
|   |   |-- api_data.json
|   |   |-- api_project.js
|   |   |-- api_project.json
|   |   |-- css
|   |   |-- fonts
|   |   |-- img
|   |   |-- index.html
|   |   |-- locales
|   |   |-- main.js
|   |   |-- utils
|   |   `-- vendor
|   |-- routes
|   |   |-- index.js
|   |   `-- users.js
|   `-- views
|       |-- error.ejs
|       `-- index.ejs

批量安装package.json的依赖.

{
  "dependencies": {
    "body-parser": "~1.18.2",
    "cookie-parser": "~1.4.3",
    "debug": "~2.6.9",
    "ejs": "~2.5.7",
    "express": "^4.15.5",
    "morgan": "~1.9.0",
    "serve-favicon": "~2.4.5"
  }
}

sudo cnpm i

3.2 运行服务

  • 文件处理
    将生成的static/docs的文件复制到public文件夹下.
  • 运行服务
node bin/www

pm2 start nodeserver.sh

【pm2指令】

序号指令描述
1pm2 start script.sh启动 bash 脚本
2pm2 list列表 PM2 启动的所有的应用程序
3 pm2 monit显示每个应用程序的CPU和内存占用情况
4pm2 show [app-name]显示应用程序的所有信息
5pm2 logs显示所有应用程序的日志
6pm2 logs [app-name]显示指定应用程序的日志
7pm2 flush清洗所有的数据
8pm2 stop all停止所有的应用程序
9pm2 stop 0停止 id为 0的指定应用程序
10pm2 restart all重启所有应用
11pm2 reload all重启 cluster mode下的所有应用
12pm2 gracefulReload allGraceful reload all apps in cluster mode
13pm2 delete all关闭并删除所有应用
14pm2 delete 0删除指定应用 id 0
15pm2 scale api 10把名字叫api的应用扩展到10个实例
16pm2 reset [app-name]重置重启数量
17pm2 startup创建开机自启动命令
18pm2 save保存当前应用列表
19pm2 resurrect重新加载保存的应用列表

3.3 访问接口

localhost:8090/index.html

在这里插入图片描述

图3.1 API接口文档

4 总结

(1) API接口文档生成步骤:构建flask运行框架,生成API接口文档,搭建Nodejs服务,运行接口服务;
(2) 由于flask的前端使用jinja2,与生成的html结构有冲突,所以使用nodejs服务运行前端,可将接口文档完成线上部署.

[参考文献]
[1]https://blog.youkuaiyun.com/lynnyq/article/details/79254290
[2]https://www.jb51.net/article/134589.htm

前端的Python应用指南（一）：快速构建 Web 服务器 - Flask vs Node.js 对比
分享有趣的、贴近生活的CS知识
12-18 2057
Flask是一个轻量级的 Python Web 框架，遵循 WSGI（Web Server Gateway Interface）标准，采用微框架（micro-framework）设计。Flask 的设计理念是让开发者能够灵活选择使用不同的库和工具，而无需过多依赖框架本身。Flask 非常适合快速构建 Web 应用，API 后端，或者进行快速原型开发。Node.js是一个基于 Chrome V8 引擎的 JavaScript 运行时环境，使得 JavaScript 可以用于服务器端编程。
Flask框架的web开发01（Restful API接口规范）
qq_53980494的博客
07-26 1488
python中的轻量级flask的基础运用，路由，蓝图，Api的绑定，以及restful api接口基本知识
Python Flask 与 Node.js Express
ChatGPTer
08-11 1622
Node.js (Express) 和 Flask 的基准测试表明，Node.js 在吞吐量和响应时间方面通常优于 Flask，尤其是在高并发性下。与大多数技术决策一样，在 Node.js (Express) 和 Flask 之间做出选择取决于您的特定项目要求、性能需求、可扩展性期望、团队专业知识以及您所需的工具和库生态系统。Python 的 Flask 和 Node.js 的 Express 是两种流行的选择，它们根据项目需求提供独特的优势。但需要注意的是，可扩展性不仅仅由框架本身决定。
flask和node.js功能上有什么区别？
m0_57236802的博客
05-15 1585
JavaScript则是Web开发的标准语言，用于编写客户端和服务器端的代码，Node.js使得JavaScript能够在服务器端运行。Flask则使用的是同步阻塞模型，这在处理CPU密集型任务和简单的请求/响应工作流时可能更简单，更直观。另一方面，Node.js则是一个运行时环境，它包含了许多内置的库和工具，可以用来构建复杂的网络应用。然而，由于JavaScript是Web开发的标准语言，Node.js的前端库和框架（如React和Angular）可能比Flask更丰富。
flask笔记：12：flask与nodejs通讯跨域问题解决
阿友的专栏
04-15 2433
run.py： from flask import Flask from flask import Response app = Flask(__name__) @app.route('/') def hello_world(): return 'hello world' #接收一个字符串 def Response_headers(content): resp = Resp
Vue中结合Flask与Node.JS的异步加载功能实现文章的分页效果
weixin_30908941的博客
02-17 253
你好！欢迎阅读我的博文，你可以跳转到我的个人博客网站，会有更好的排版效果和功能。 此外，本篇博文为本人Pushy原创，如需转载请注明出处：https://pushy.site/posts/1519817324 如果你了解前端，肯定对AJAX不陌生，那么通过AJAX技术能够达到更新网页部分内容来达到加载其他信息的效果。通过AJAX我们可以来对文章进行优化，如果我们的博客在首页载入时就加载全部的文...
使用apidoc管理RESTful风格Flask项目接口文档方法
09-20
使用apidoc管理RESTful风格Flask项目接口文档的方法是一种高效且规范的方式，它可以帮助开发者创建清晰、结构化的API文档，方便团队协作和对外提供服务。本文将详细介绍如何使用apidoc与Flask结合来构建RESTful API...
python vue flask_Python构建RESTful网络服务[Flask篇：用Flask+Vue.js打造全栈单页面应用]...
weixin_39829073的博客
12-20 302
前言本来在着手写关于使用Flask构建RESTful网络服务的文章，正好看到一篇相关文章，提供了一个Flask+vue构建全栈单页面应用的例子，觉得不错，就在此分享给大家。作者Oleg Agapov ，似乎是俄语使用者，不过这篇文章是用英文写的，文风细致友好，可以一读。考虑到一些朋友不方便查看外网，特此翻译并转载到知乎专栏。以下是全文及几条网友问答翻译。注意：阅读本文需要一点点的Flask知识和一...
python flask api接口安全_使用apidoc管理RESTful风格Flask项目接口文档方法
weixin_39980002的博客
12-19 479
使用apidoc管理RESTful风格Flask项目接口文档方法1.安装nodejssudo apt-get install nodejssudo apt install nodejs-legacysudo apt install npm2.安装apidocnpm install apidoc -g3.Flask扩展包安装pip install flask-apidoc4.添加扩展包到Flask项...
【后端】Flask vs Django vs Node.js 对比分析
最新发布
专注大前端
03-03 1167
如聊天应用、实时推送、WebSocket 等，Node.js 的异步特性更合适。：轻量、灵活，开发者需要自己选择数据库、身份认证等组件。，npm 生态强大。常用于高并发、实时应用（如聊天、视频流）。，内置 ORM、身份认证、管理后台，适合大型项目或快速开发。✔ 实时应用（如 WebSocket 聊天、在线协作工具）✔ 企业级 Web 应用（如 CRM、ERP、管理系统）✔ 高并发 API（如 Netflix、Uber）✔ 轻量级 API（如用户管理、数据查询），如聊天应用、实时数据推送等。
微信小程序 uniapp+flask+nodejs餐饮美食点单系统
QQ402205496的博客
03-29 1073
在信息技术迅速发展的今天，计算机技术已经遍及全球，使社会发生了巨大的变革，现今各种智能手机层出不穷，各类基于手机平台的软件应运而生，其中，在众多交流软件中，微信备受人们青睐，近年来，微信发展规模越来越大，越来越多的人开始使用微信，目前智能手机系统的普及，人们手机上基本都有了微信，据调查发现，中国约90%的人选择使用微信。,越来越多饮食方面的资本商家，开始建设以微信位基础的客户下单交易平台，餐饮企业间竞争激烈，如何更好的进行餐饮宣传，满足用户点餐需求，成了餐饮商家关注的热点。3.2.1经济可行性 6。
【小沐学Python】Python实现Web服务器（Flask+Vue+node.js，web单页增删改查）
爱看书的小沐
05-12 2302
Flask是一个简单但功能强大的Python微Web框架，非常适合构建RESTful API。像Sinatra（Ruby）和Express（Node）一样，它是最小和灵活的，所以你可以从小处着手，然后根据需要构建更复杂的应用程序。╮(￣▽￣)╭如果您感觉方法或代码不咋地//(ㄒoㄒ)//，就在评论处留言，作者继续改进；o_O???如果您需要相关功能的代码定制化开发，可以留言私信作者；(✿◡‿◡)！！
常见错误：使用nodejs请求flask出现400错误
星空下的Along君
01-14 903
开发者日志：使用nodejs请求flask出现400错误 问题：使用nodejs请求flask出现400错误，如下图： vscode：nodejs pycharm：python-flask nodejs代码 const https = require('https') const option = { hostname: '127.0.0.1', port: 5000, path: '/manage/mall/pictures/name', ...
基于python+vue+elementUI疫情防控下医院人员调动系统(前后端分离)#毕业设计
z459382737的博客
06-19 408
随着信息技术和网络技术的飞速发展，人类已进入全新信息化时代，传统管理技术已无法高效，便捷地管理信息。为了迎合时代需求，优化管理效率，各种各样的管理系统应运而生，各行各业相继进入信息管理时代，疫情防控下医护人员调度系统就是信息时代变革中的产物之一。 任何系统都要遵循系统设计的基本流程，本系统也不例外，同样需要经过市场进行调研，医院需求进行分析，概要设计，系统详细设计，测试和编码等步骤，设计并实现了疫情防控下医护人员调度系统。系统选用B/S模式，应用Python技术， MySQL为后台数据库。系统主要包括首页，
Django和Flask这两个框架在设计上各方面
JohnApostle的博客
06-16 674
一、整体设计方面>>首先，两者都是非常优秀的框架。整体来讲，两者设计的哲学是区别最大的地方。>Django提供一站式的解决方案，从模板、ORM、Session、Authentication等等都分配好了，连app划分都做好了，总之，为你做尽量多的事情，而且还有一个killer级的特性，就是它的admin，配合django-suit，后台就出来了，其实最初Django就是由在新闻发布公司工作的人设计
基于nodejs天气数据可视化平台flask-django-python
QQ_1963288475的博客
03-18 1116
 天气变幻无常， 为数据分析提供大量函数，通过利用nodejs程序对气象网站大量的气象信息进行分析,可以挖掘出关于气象气候演变的规律信息,为气象预报提供更丰富的参考依据。国内外都专注于各种物理技术对于天气的预报与分析，并没有过多地关于数据的可视化以及收集的研究，大多数产品的功能相差不大，这样获得信息可能比较分散并且不太利于普通人的阅读。但是不管是国内还是国外的这一些已有的方案，都为本课题提供了大量的经验。
基于nodejs的高考志愿推荐系统设计与实现flask-django-python
QQ1963288475的博客
03-18 941
随着网络技术的飞速发展，我国大学的资助管理体系也得到了飞速的发展。这种网络方式给人们的长期使用带来了深刻的后果，在这样的社会背景下，开发一个适合于所有的人都可以操作的、简单的、方便的高考志愿推荐系统，具有很好的发展前景。
python代码大全简单图解_Python教程：10个简单窍门带你提高Python数据分析速度（附代码）...
weixin_39959126的博客
11-23 201
Python教程：10个简单窍门带你提高Python数据分析速度（附代码）不管在做什么事情，提示和一些小技巧总是非常有用的，在编程领域更是如此。有时候，小小的黑科技可以节省你大量的时间和精力。一个小的快捷方式或附加组件有时会是天赐之物，可以成为实用的效率助推器。所以，这期给大家介绍下自己编程时最喜欢使用的一些提示和小技巧，也是花了些时间整理的！有些可能是大家熟悉的，而有些可能是新鲜的，我相信它们会...
基于Python+flask+node.js+Mysql的书籍影视交流平台（类似豆瓣）
毕业作品网站
03-09 457
103 找回密码 已注册用户丢失密码后，通过审核找回密码。5 小组系统 用户参与小组发表帖子，小组管理员管理帖子。305 发表图文 用户在某一个话题下发表相关言论和图片。407 加精帖子 小组管理员将某一个帖子设为精华帖。408 删除帖子 小组管理员删除了一个非法的帖子。404 参与小组 用户成为了某一个小组的参与者。405 发表帖子 用户在某一个小组中发表了帖子。303 参与话题 用户成为某一个话题的参与者。4 话题系统 用户参与话题以及发表相关内容。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

天然玩家

坚持才能做到极致

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值