python-flask_restful+flasgger

最新推荐文章于 2024-05-27 18:53:08 发布

抓到小松鼠

最新推荐文章于 2024-05-27 18:53:08 发布

阅读量261

点赞数 1

分类专栏： # flask 文章标签： python flask

本文链接：https://blog.csdn.net/qq_45939519/article/details/136483717

版权

flask 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

文章介绍了如何在Flask应用中使用Flasgger库创建RESTfulAPI，包括GET和POST请求的处理，以及Swagger文档的生成。它展示了如何定义API标签、描述、参数和响应状态码。

摘要由CSDN通过智能技术生成

flasgger文档
https://gitee.com/Flasgger/flasgger
swagger访问地址
/apidocs/

from flask_restful import Resource, Api
from flask import Flask, request
from flasgger import Swagger

class Hello(Resource):
    def get(self):
        """
        hello-get
        ---
        tags:
          - hello
        description:
            测试

        responses:
          201:
              description: 测试


              example: {'code':1,'message':“hello”}
          406:
            description: 注册有误，参数有误等

        """

        return {"code": 201, "message": "hello"}

    def post(self):
        """
        hello-post
        ---
        tags:
          - hello
        description:
            测试-post
        parameters:
          - name: data
            in: body
            required: true
            schema:
              id: data
              required:
                - username
              properties:
                username:
                  type: string
                  description: 用户名.

        responses:
          201:
              description: 注册成功


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

        """
        username = request.json["username"]

        return {"code": 201, "message": f"hello {username}"}

app = Flask("app")
api = Api(app=app)
api.add_resource(Hello, "/hello")
swagger = Swagger(app=app)

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=5001)