Swagger API使用json验证使用json

Question

我正在使用Swagger生成Restful API：

@POST
@Consumes({ "application/json" })
@Produces({ "application/json" })
@io.swagger.annotations.ApiOperation(value = "Create a task", notes = "", response = Tasks.class)
@io.swagger.annotations.ApiResponses(value = { 
    @io.swagger.annotations.ApiResponse(code = 200, message = "created task", response = Tasks.class),
    @io.swagger.annotations.ApiResponse(code = 404, message = "task not found", response = Tasks.class),
    @io.swagger.annotations.ApiResponse(code = 200, message = "unexpected error", response = Tasks.class) })
public Response createTask(@ApiParam(value = "The task to create" ,required=true ) NewTask newTask)
throws NotFoundException {
    return delegate.createTask(newTask);
}

这个API接受json字符串并从中生成java对象。这在一个例外情况下运行良好：API接受任何正确格式的json字符串，但忽略json的内容，这意味着我得到一个使用默认值创建的对象。

所以我的问题是:在生成实际的java对象之前，如何验证传入的jsonstring(针对json模式)？

Answer 1

有swagger-request-validator，它有几个适配器用于各种框架，例如:Spring Web MVC

它能够针对Swagger/OpenAPI 2或OpenAPI 3方案验证请求和/或响应。

参见这里:对照Java中的Swagger定义验证JSON消息以获得更详细的答案。

Answer 2

由于您不希望在方法中接收JSON字符串，并且Bean验证不是您的验证选项，因此您可以尝试＜code＞MessageBodyWriter

JAX-RS使用< code>MessageBodyWriter

请参阅以下示例：

@Provider
@Produces("application/json")
public class CustomMessageBodyWriter implements MessageBodyWriter<Object> {

    @Override
    public boolean isWriteable(Class<?> type, Type genericType,
                               Annotation[] annotations, MediaType mediaType) {
        return true;
    }

    @Override
    public long getSize(MyBean myBean, Class<?> type, Type genericType,
                        Annotation[] annotations, MediaType mediaType) {

        // Deprecated by JAX-RS 2.0
        return 0;
    }

    @Override
    public void writeTo(Object object, Class<?> type, Type genericType,
                        Annotation[] annotations, MediaType mediaType,
                        MultivaluedMap<String, Object> httpHeaders,
                        OutputStream entityStream) throws IOException {

        // Read the entityStream
        // Perform the validation against your schema
        // Write to the object
    }
}

@Provider注释使 JAX-RS 运行时在提供程序扫描阶段自动发现该类。