Interface OpenApiUi

  • All Superinterfaces:
    All Known Implementing Classes:

    public interface OpenApiUi
    extends Service
    Behavior for OpenAPI UI implementations.
    • Method Detail

      • builder

        static OpenApiUi.Builder<?,​?> builder()
        Creates a builder for a new OpenApiUi instance.
        new builder
      • prepareTextResponseFromMainEndpoint

        boolean prepareTextResponseFromMainEndpoint​(ServerRequest request,
                                                    ServerResponse response)
        Gives the UI an opportunity to respond to a request arriving at the OpenAPISupport endpoint for which the best-accepted MediaType was text/html.

        An implementation should return true if it is responsible for a particular media type whether it handled the request itself or delegated the request to the next handler. For example, even if the implementation is disabled it should still return true for the HTML media type.

        request - the request for HTML content
        response - the response which could be prepared and sent
        whether the UI did respond to the request