软件测试|测试平台后端开发Flask框架-集成Swagger文档

最新推荐文章于 2024-06-07 10:01:36 发布

原创

最新推荐文章于 2024-06-07 10:01:36 发布 · 756 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#flask #python #后端

Swagger是一个用于生成、描述、调用和可视化RESTful风格Web服务的框架，能有效解决后端接口文档更新不及时的问题。通过定义命名空间、装饰器和parser，可以方便地创建和管理API接口，同时提供接口文档界面和参数校验功能，提高开发效率。

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

介绍

接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后，编写接口文档更是重中之重。但是由于项目周期等原因后端人员经常出现无法及时更新，导致前端人员抱怨接口文档和实际情况不一致，接口文档不规范，不及时更新等问题。
Swagger 可以完美的解决上述问题， Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务，它支持自动生成接口文档界面，支持在界面上测试API接口等功能

namespace(命名空间)的使用

from flask import Flask
from flask_restx import Resource, Api, Namespace

app = Flask(__name__)
api = Api(app)
# 定义命名空间
demo = Namespace("demo", description='demo学习')
case = Namespace("case", description='case练习')


# @api.route('/case')
# 定义子路由,如果没有的话，传空字符串即可
@case.route("")
class Case(Resource):
    # 定义restful 风格的方法
    def get(self):
        return {
   
   'code': 0, 'msg': 'get success'}

    def post(self):
        return {
   
   'code': 0, 'msg': 'post success'}

    def put(self):
        return {
   
   'code': 0, 'msg': 'put success'}

    def delete(self):
        return {
   
   'code': 0, 'msg': 'delete success'}


# @api.route('/demo')
@demo.route("")
class Demo(Resource):
    # 定义restful 风格的方法
    def get(self):