flask_restplus和swagger
1、使用教程
data_api.py
from flask import Flask
from flask_restplus import Api
from flask import request
from flask_restplus import Resource, fields
import json
from weibo_params import news_input, news_output
from gevent import pywsgiapp = Flask(__name__)
# swagger文档标题
api = Api(app, version='1.0', title='gEdi',description='平台')
news_analysis = api.namespace("NewsAnalysis", "/")# 参数解析
parser = api.parser()# 配置post方法需要传递的接口输入参数
news_input = api.model('news_data', news_input)
# 配置返回参数
news_result = api.model('news_result', news_output)@news_analysis.expect(parser)
class NewsAnalysis(Resource):"""新闻集成接口"""@news_analysis.doc(body=news_input)@news_analysis.marshal_with(news_result)def post(self):"""输入某一条新闻信息"""receive_params = request.get_data(as_text=True)receive_params = receive_params.replace("\\\\", "\\")print(receive_params)post_value = json.loads(receive_params,encoding="utf-8")print("post_value", post_value)weibo_id = post_value['weibo_id']results = {"weibo_id": weibo_id}print(results)return results, 200# 配置各命名空间下的接口
news_analysis.add_resource(NewsAnalysis, '/')if __name__ == '__main__':# app.run(host="127.0.0.1", port="5003", debug=True)server = pywsgi.WSGIServer(('127.0.0.1', 5000), app)server.serve_forever()
weibo_params.py
from flask_restplus import fieldsdefault_data = {"weibo_id": "3741282071656011","content": "携带犬粮入境 一律没收销毁","url": "https://m.weibo.cn/status/BhjVZ6WNR?mblogid=BhjVZ6WNR&luicode=10000011&lfid=100103type%3D1%26q%3D%E8%BF%9B%E5%87%BA%E5%A2%83","date": "2014-08-08 13:10:18","keyword": "进出境","author": "贵州日报官微","crawl_time": "2021-09-23","is_verified": "1","verified_type": "3"
}news_input = {"weibo_id": fields.String(required=True, description=''),"content": fields.String(required=False, description='',default=default_data["content"]),"url": fields.String(required=False, description='',default=default_data["url"]),"date": fields.String(required=False, description='',default=default_data["date"]),"keyword": fields.String(required=False, description='',default=default_data["keyword"]),"author": fields.String(required=False, description='',default=default_data["author"]),"crawl_time": fields.String(required=False, description='',default=default_data["crawl_time"]),"is_verified": fields.String(required=False, description='',default=default_data["is_verified"]),"verified_type": fields.String(required=False, description='',default=default_data["verified_type"])
}news_output = {"weibo_id": fields.String(required=True, description='')
}
运行data_api.py文件即可实现
测试方法:
1)将上述程序跑起来以后,在浏览器中输入:http://127.0.0.1:5000/
flask_restplus和swagger相关推荐
- Flask 系列之 构建 Swagger UI 风格的 WebAPI
说明 操作系统:Windows 10 Python 版本:3.7x 虚拟环境管理器:virtualenv 代码编辑器:VS Code 实验 环境初始化 # 创建项目目录 mkdir helloworl ...
- flask+swagger
由于写完flask接口后,需要向前端提供swagger接口文档,因此需要自动生成swagger文档. 1. 安装flask-restplus 采用如下命令安装flask-restplus pip in ...
- 前后端分离必备工具:Swagger快速搞定(整合SpringBoot详细教程)
本文根据狂神教学视屏同步所做笔记 目录 一.Swagger简介 1. 前后端分离 2. Swagger引入 二.SpringBoot集成Swagger 1. 新建springboot项目 2. 导入S ...
- NSwagStudio for Swagger Api
本案例主要说明如何使用NSwag 工具使用桌面工具快速生成c# 客户端代码.快速的访问Web Api. NSwagStudio 下载地址 比较强大.可以生成TypeScript.WebApi Cont ...
- Spring Boot集成Swagger导入YApi@无界编程
接口APi开发现状 现在开发接口都要在类似YApi上写文档,这样方便不同的团队之间协作,同步更新接口,提高效率. 但是如果接口很多,你一个个手工在YApi去录入无疑效率很低. 如果是使用Spring ...
- oracle web API,在Web API程序中使用Swagger做接口文档
#### 创建Web API程序 在VS2019中创建一个ASP.NET Web应用程序,选择Web API来创建RESTful的HTTP服务项目,构选MVC和Web API核心引用. #### 安装 ...
- MP实战系列(二)之集成swagger
其实与spring+springmvc+mybatis集成swagger没什么区别,只是之前写的太不好了,所以这次决定详细写. 提到swagger不得不提rest,rest是一种架构风格,里面有对不同 ...
- Swagger 生成 PHP restful API 接口文档
需求和背景 需求: 为客户端同事写接口文档的各位后端同学,已经在各种场合回忆了使用自动化文档工具前手写文档的血泪史. 我的故事却又不同,因为首先来说,我在公司是 Android 组负责人,属于上述血泪 ...
- 扔掉Swagger,试试这款功能强大,零注解侵入的API接口文档生成工具!
欢迎关注方志朋的博客,回复"666"获面试宝典 介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-d ...
- 你还在用Swagger?试试这个神器!
点击上方蓝色"方志朋",选择"设为星标" 回复"666"获取独家整理的学习资料! 作者:Java旅途/ 周明尧(本文来自作者投稿) 今天给大 ...
最新文章
- 最详细的最小堆构建、插入、删除的过程图解
- 奇技淫巧:在spring官网上下载历史版本的spring插件,springsource-tool-suite
- C语言变量初始化是必须的
- @Pathvariable的参数允许为空的问题的解决
- Acrobat Pro DC 2021 for Mac(pdf编辑器)中文版
- Redhat 7 进入救援模式
- 【密码学】让我们去看一个《摩尔斯电码里的爱情故事》: 爱情最好的样子,就是我爱你的同时你也爱我
- HTML+CSS静态页面`西安旅游网站设计——西安旅游(7页) 大学生旅游网页作品 出行网页设计作业模板 学生游玩网页制作源代码下载
- devc语言图形编程教程_C语言编程工具:Dev - C++ 简单安装和使用!新手福利!
- java计算机毕业设计教师科研成果管理源码+mysql数据库+系统+lw文档+部署
- xlsx文件怎么打开?3种方法:Excel+WPS+兼容包来搞定
- 浅析小程序云原生数据库的设计与应用
- pap.er for mac高清壁纸下载后的储存位置在哪里?小编告诉你!!
- 分享一下 软件测试面试历程和套路,真的很实在
- 游戏设计模式阅读笔记18——优化模式(对象池模式)
- UVA:1593 代码对齐
- 阿里云服务器的端口有什么用,常用的端口有哪些,如何配置
- Syslinux使用
- 统计分析 -- 正态分布
- 图像检索(二)--综述(2016年之前)