sanic-如何指定所需的JSON？

Question

I would like to specify the required JSON for a controller get / post methods in order for it to show in SwaggerUI.

For example, I want request.json to look like this:

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

I initialize SwaggerUI like this:

from sanic_openapi import swagger_blueprint, openapi_blueprint

app = Sanic(__name__)

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

How can I make both keys show up in parameters ?

Answer 1

There is sanic_openapi.doc.consumes decorator for decorating view functions to document their input. This naming of the decorator function follows from the OpenAPI specification .

Here is one way to apply it:

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

You can model your input using a class.

class RecordingTest:
    key1 = str
    key2 = int

Use the modeled input above in the following manner

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

Answer 2

You did not see this params in swagger because your get method is on class. Sanic-openapi and Sanic-swagger does not support class based views yet. :(