前言

学习使用sanic-openapi来构建API

安装

pip3.6 install sanic-openapi

使用

from sanic.response import json

from sanic.blueprints import Blueprint

from sanic_openapi import swagger_blueprint, openapi_blueprint,doc

params = {

'id': {'type': 'integer', 'description': '数据ID', 'in': 'from', 'required': True},

'fields': {'type': 'string', 'description': '返回的字段：默认是全部', 'in': 'query', 'required': False},

}

test_data = {

'id':1,

'fields':'Int'

}

api = Blueprint('todos', url_prefix='v1.0/todos')

@api.get('/', strict_slashes=True)

@doc.route('获取一条数据','根据用户id获取一条数据',{'id': {'type': 'integer', 'description': '数据ID', 'in': 'query', 'required': True}},params)

async def get(request):

return json(test_data)

if __name__ == '__main__':

app = Sanic(__name__)

app.blueprints(api)

app.blueprint(openapi_blueprint)

app.blueprint(swagger_blueprint)

app.run(debug=True)

查看