Interface RestRegistry.RestService

Enclosing interface:
RestRegistry
public static interface RestRegistry.RestService
Details about the REST service

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBasePath()
    Gets the base path to the REST service
    String
    getBaseUrl()
    Gets the base url to the REST service
    Consumer
    getConsumer()
    Gets the consumer of the REST service
    @Nullable String
    getConsumes()
    Optional details about what media-types the REST service accepts
    @Nullable String
    getDescription()
    Optional description about this rest service.
    long
    getHits()
    Number of requests processed by this REST service.
    @Nullable String
    getInType()
    Optional detail about input binding to a FQN class name.
    String
    getMethod()
    Gets the HTTP method (GET, POST, PUT etc)
    @Nullable String
    getOperationId()
    Gets the operationId from the OpenAPI contract (contract-first routes only)
    @Nullable String
    getOutType()
    Optional detail about output binding to a FQN class name.
    @Nullable String
    getProduces()
    Optional details about what media-types the REST service returns
    @Nullable String
    getRouteId()
    Gets the route id that this REST service is using
    @Nullable String
    getSpecificationUri()
    Gets the specification URI of the OpenAPI contract (contract-first routes only), e.g.
    String
    getState()
    Gets the state of the REST service (started, stopped, etc)
    @Nullable String
    getUriTemplate()
    Gets the uri template
    String
    getUrl()
    Gets the absolute url to the REST service (baseUrl + uriTemplate)
    boolean
    isContractFirst()
    Is the rest service based on code-first or contract-first
    boolean
    isSpecification()
    Is this the API contract specification (ie api-doc)

  • Method Details

    • getConsumer

      Consumer getConsumer()
      Gets the consumer of the REST service

    • isSpecification

      boolean isSpecification()
      Is this the API contract specification (ie api-doc)

    • isContractFirst

      boolean isContractFirst()
      Is the rest service based on code-first or contract-first

    • getState

      String getState()
      Gets the state of the REST service (started, stopped, etc)

    • getRouteId

      @Nullable String getRouteId()
      Gets the route id that this REST service is using
      Since:
      4.21

    • getOperationId

      @Nullable String getOperationId()
      Gets the operationId from the OpenAPI contract (contract-first routes only)
      Since:
      4.21

    • getUrl

      String getUrl()
      Gets the absolute url to the REST service (baseUrl + uriTemplate)

    • getBaseUrl

      String getBaseUrl()
      Gets the base url to the REST service

    • getBasePath

      String getBasePath()
      Gets the base path to the REST service

    • getUriTemplate

      @Nullable String getUriTemplate()
      Gets the uri template

    • getMethod

      String getMethod()
      Gets the HTTP method (GET, POST, PUT etc)

    • getConsumes

      @Nullable String getConsumes()
      Optional details about what media-types the REST service accepts

    • getProduces

      @Nullable String getProduces()
      Optional details about what media-types the REST service returns

    • getInType

      @Nullable String getInType()
      Optional detail about input binding to a FQN class name.

      If the input accepts a list, then List<class name> is enclosed the name.

    • getOutType

      @Nullable String getOutType()
      Optional detail about output binding to a FQN class name.

      If the output accepts a list, then List<class name> is enclosed the name.

    • getDescription

      @Nullable String getDescription()
      Optional description about this rest service.

    • getSpecificationUri

      @Nullable String getSpecificationUri()
      Gets the specification URI of the OpenAPI contract (contract-first routes only), e.g. petstore.yaml or classpath:openapi.json.
      Since:
      4.21

    • getHits

      long getHits()
      Number of requests processed by this REST service.
      Since:
      4.21