专栏首页Python在flask中使用swagger(flasgger使用方法及效果展示)

在flask中使用swagger(flasgger使用方法及效果展示)

一. 部分代码及效果

from flask import Flask
from flasgger import Swagger

import config

app = Flask(__name__)
app.config.from_object(config)

swagger_config = Swagger.DEFAULT_CONFIG
swagger_config['title'] = config.SWAGGER_TITLE    # 配置大标题
swagger_config['description'] = config.SWAGGER_DESC    # 配置公共描述内容
swagger_config['host'] = config.SWAGGER_HOST    # 请求域名

# swagger_config['swagger_ui_bundle_js'] = '//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js'
# swagger_config['swagger_ui_standalone_preset_js'] = '//unpkg.com/swagger-ui-dist@3/swagger-ui-standalone-preset.js'
# swagger_config['jquery_js'] = '//unpkg.com/jquery@2.2.4/dist/jquery.min.js'
# swagger_config['swagger_ui_css'] = '//unpkg.com/swagger-ui-dist@3/swagger-ui.css'
Swagger(app, config=swagger_config)
@blueprint.route('/register/', methods=['POST'])
def register():
    """
    用户注册
    ---
    tags:
      - 用户相关接口
    description:
        用户注册接口,json格式
    parameters:
      - name: body
        in: body
        required: true
        schema:
          id: 用户注册
          required:
            - username
            - password
            - inn_name
          properties:
            username:
              type: string
              description: 用户名.
            password:
              type: string
              description: 密码.
            inn_name:
              type: string
              description: 客栈名称.
            phone:
              type: string
              description: 手机号.
            wx:
              type: string
              description: 微信.

    responses:
      201:
          description: 注册成功


          example: {'code':1,'message':注册成功}
      406:
        description: 注册有误,参数有误等

    """
    pass

二. 大致介绍及详细文档推荐

flasgger配置文件解析:

  • 在flasgger的配置文件中,以yaml的格式描述了flasgger页面的内容;
  • tags标签中可以放置对这个api的描述和说明;
  • parameters标签中可以放置这个api所需的参数,如果是GET方法,可以放置url中附带的请求参数,如果是POST方法,可以将参数放置在schema子标签下面;
  • responses标签中可以放置返回的信息,以状态码的形式分别列出,每个状态码下可以用schema标签放置返回实体的格式;

只是简单记录,其他可以看下面一些链接

使用swagger 生成 Flask RESTful API swagger文档在线编辑样例 swagger和openAPI: 描述参数 flasgger

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • pymysql模块

    一、模块安装 #安装 pip3 install pymysql 二、链接、执行sql、关闭(游标) ? import pymysql user=input('用...

    用户1214487
  • linux每日命令(24):Linux 目录结构

    对于每一个Linux学习者来说,了解Linux文件系统的目录结构,是学好Linux的至关重要的一步.,深入了解linux文件目录结构的标准和每个目录的详细功能,...

    用户1214487
  • Django——model基础

    ORM 映射关系:     表名 <-------> 类名 字段 <-------> 属性     表记录 <------->类实例对象...

    用户1214487
  • Nuxt.js踩坑分享

    Nuxt.js 通过 vue-meta 实现头部标签管理,通过查看文档发现,可以按照如下方式配置:

    前端博客 : alili.tech
  • SpringCloud Config 分布式配置

    在分布式系统中,由于服务数量巨多,为了方便服务配置文件统一管理,实时更新,所以需要分布式配置中心组件。市面上开源的配置中心有很多,BAT每家都出过,360的QC...

    掌上编程
  • springCloud - 第8篇 - 配置文件管理中心 - 集群模式(负载匀衡)使用

    当微服务系统中 应用服务有很多时(serviceA 、serviceB ...),会都从同一个配置中心读取配置文件。此时,可选择集群模式部署配置文件管理中心的 ...

    微风-- 轻许--
  • springCloud - 第9篇 - 同步配置文件(消息总线方式)

    一、 微服务系统中有多个服务应用,也会有多个配置文件。此时也可用 springcloud bus 来实现对配置文件的管理。

    微风-- 轻许--
  • 分布式配置

    分布式配置:配置管理工具包,让你可以把配置放到远程服务器,集中化管理集群配置,目前支持本地存储、Git以及Subversion。 在生产环境,由于配置繁多,造成...

    dalaoyang
  • 奥巴马网络安全专员告诉你如何保护网上购物安全

    网购可谓是假期“必不可少”的一部分了,网络犯罪分子也发现,在某些重大节日里,人们在网购的时候或多或少都会放松警惕,而这也给犯罪分子们提供了可乘之机。 ? 如果在...

    FB客服
  • 简直不要太硬了!一文带你彻底理解文件系统

    所有的应用程序都需要存储和检索信息。进程运行时,它能够在自己的存储空间内存储一定量的信息。然而,存储容量受虚拟地址空间大小的限制。对于一些应用程序来说,存储空间...

    cxuan

扫码关注云+社区

领取腾讯云代金券