sanic-如何指定所需的JSON？

Question

我想为控制器的get / post方法指定所需的JSON，以便使其在SwaggerUI中显示。

例如，我希望request.json看起来像这样：

{
  'key1': <int>,
  'key2': <string>
}

我这样初始化SwaggerUI：

from sanic_openapi import swagger_blueprint, openapi_blueprint

app = Sanic(__name__)

# Set up SwaggerUI
app.blueprint(openapi_blueprint)
app.blueprint(swagger_blueprint)

如何使两个键都显示在parameters ？

Answer 1

有sanic_openapi.doc.consumes装饰器，用于装饰视图函数以记录其输入。 装饰器函数的命名遵循OpenAPI规范 。

这是一种应用方法：

@app.post('/recording_test')
@doc.summary('Tests a recording')
@doc.consumes({'key1': str, 'key2': int}, location='body')
async def create_recording_test(request):
    ...

您可以使用类对输入进行建模。

class RecordingTest:
    key1 = str
    key2 = int

通过以下方式使用上面的建模输入

@app.post('/recording_test')
@doc.summary('Tests a recording')
@doc.consumes(RecordingTest, location='body')
async def create_recording_test(request):
    ...

Answer 2

由于您的get方法位于类中，因此您不会大张旗鼓地看到这些参数。 Sanic-openapi和Sanic-swagger还不支持基于类的视图。 :(