Package org.praxisplatform.uischema.rest.response

Class RestApiResponse<T>

java.lang.Object
org.praxisplatform.uischema.rest.response.RestApiResponse<T>
Type Parameters:
T - tipo do payload da resposta
Direct Known Subclasses:
RestApiResponseDistributionStatsResponse, RestApiResponseGroupByStatsResponse, RestApiResponseTimeSeriesStatsResponse
public class RestApiResponse<T> extends Object
Envelope padrao de resposta da API Praxis.

Este tipo unifica a forma de expor sucesso, falha, links HATEOAS e erros estruturados na superficie HTTP da plataforma. Controllers base e endpoints documentais o usam como contrato padrao para evitar formatos heterogeneos entre modulos e recursos.

Em respostas bem-sucedidas, o campo data carrega o payload principal e o campo _links expõe affordances HATEOAS quando habilitadas. Em respostas de falha, o envelope pode trazer mensagem resumida e uma lista de CustomProblemDetail.

Since:
1.0.0

  • Constructor Details

    • RestApiResponse

      public RestApiResponse()

  • Method Details

    • success

      public static <T> RestApiResponse<T> success(T data, org.springframework.hateoas.Links links)
      Cria um envelope de sucesso.
      Parameters:
      data - corpo da resposta
      links - links HATEOAS, quando aplicavel
      Returns:
      envelope de sucesso preenchido

    • failure

      public static <T> RestApiResponse<T> failure(String message, List<CustomProblemDetail> errors)
      Cria um envelope de falha com mensagem e detalhes estruturados.
      Parameters:
      message - mensagem resumida de erro
      errors - lista de detalhes de problema
      Returns:
      envelope de falha preenchido