JAX-RS，当 POST 失败时，如何获取原始 JSON

Question

我的代码使用外部 API。 当我用正确的参数调用它时，我得到了预期的答案。

当我用错误的参数调用它时（从不正确的工作数据的意义上来说是错误的，技术上是可以的），我的代码会抛出一个异常。 我期待一个包含数据验证错误“sex='3' 错误”的字符串。

API 使用 JSON 并返回 JSON。 我用 javax.ws.rs 调用它

这是我调用 API 的方法

    public final String API_URL= "http://sv-t-vtl-pgih-vidal:9900/solfeges/api/v0";

    private void test(String json)
    {
        // The proxy for calling the API.
        SolfegesServices proxy = ProxyFactory.create(SolfegesServices.class, API_URL);

        // 
        try
        {
            // Call the API
            String retourBrut = proxy.callfactureapi(json);

            System.out.println(retourBrut);
        }
        catch (RuntimeException e)
        {
            e.printStackTrace();
        }
    }

这是我用来声明 API 的另一个类

import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;

import fr.pgih.ope.act.dim.gestionfides.utils.RetourSolfegesException;

@Produces("application/json")
@Consumes("application/json")
public interface SolfegesServices
{
    @POST
    @Path("/factures")
    public String callfactureapi(String json) throws RetourSolfegesException;
}

这两个类都足以调用 API。

当使用不正确的数据调用 API 时，该 API 会返回状态为 422 的 JSON。 发生这种情况时，代码会抛出一个 runtimeException 异常，其中不包含 API 的错误信息。

如果出现错误，如何获取 API 返回的 JSON？

注意。 如果成功，JSON 看起来像

{
statut:200,
message:"succes",
b2:"some content"
}

如果失败，我期待类似

{
statut:422, (or 400)
message:"fail to...",
reason:"sexe='3' is incorrect"
}

尽管有很多类似的案例，但我已经挖掘了整个 stackoverflow 网站和其他一些网站，但没有找到解决我的问题的方法。

如果我尝试使用 Postman（执行 Web 请求的外部工具）调用 API，一切看起来都很好。

Answer 1

您可以从控制器返回 ResponseEntity。 响应实体可以基于您提到的验证失败，并且此 json 消息应该是正文的一部分。

ResponseEntity response = ResponseEntity.status(HttpStatus.UNPROCESSABLE_ENTITY).body(jsonMessage).build();

Answer 2

最后，我集成了 API 的工具来调用它（使用 Swagger）。 它......工作......几乎完美。

Answer 3

最后（复出）。 我对异常过滤器进行了额外收费以捕获它们（http statut 400 或 422）。

ClientResponseFilter.filter(ClientRequestContext reqCtx, ClientResponseContext resCtx)

public class ClientResponsesExceptionFilter implements ClientResponseFilter
{

    @Override
    public void filter(ClientRequestContext reqCtx, ClientResponseContext resCtx)
            throws ApiSolfegesException, IOException
    {
        if (resCtx.getStatus() == Response.Status.BAD_REQUEST.getStatusCode() || resCtx.getStatus() == 422)
        {
            ...
        }
    }
}

我在这里用

@Override
    public ModelApiResponse facturesPost(DossiersPmsi body)
    {

        CustomResteasyJackson2Provider resteasyJacksonProvider = new CustomResteasyJackson2Provider();

        // Ajout d'un Mapper pour gérer la sérialisation et désrialisation json des dates proprement
        ObjectMapper mapper = new ObjectMapper();
        JavaTimeModule javaTimeModule = new JavaTimeModule();
        javaTimeModule.addDeserializer(LocalDate.class, new LocalDateDeserializer());
        javaTimeModule.addSerializer(new LocalDateSerializer());
        mapper.registerModule(javaTimeModule);
        resteasyJacksonProvider.setMapper(mapper);

        // ajout d'un filtre pour les exception
        ClientResponsesExceptionFilter filter = new ClientResponsesExceptionFilter();

        // appel de l'api solfeges
        ResteasyClient client = new ResteasyClientBuilder().register(resteasyJacksonProvider)
                .register(filter).build();
        ResteasyWebTarget target = client.target(UriBuilder.fromPath(URL_SOLFEGE));
        FacturesApi proxy = target.proxy(FacturesApi.class);
        return proxy.facturesPost(body);
    }

我还使用这些从以下位置获取 JSON： https : //www.codota.com/code/java/methods/javax.ws.rs.client.ClientResponseContext/getEntityStream

private String getResponseBody(ClientResponseContext context) throws IOException
    {
        // La variable qui contient la description de l'erreur dans un fichier JSON.
        String jsonEchec = null;

        // Essayer de récupérer le JSON
        try (InputStream entityStream = context.getEntityStream())
        {
            if (entityStream != null)
            {
                byte[] bytes = IOUtils.toByteArray(entityStream);
                context.setEntityStream(new ByteArrayInputStream(bytes));
                jsonEchec = new String(bytes);
            }
        }

        // Retour du JSON descriptif de l'erreur
        return jsonEchec;
    }