Package com.tccc.kos.commons.core.dispatcher.annotations

package com.tccc.kos.commons.core.dispatcher.annotations
Contains annotations used when writing REST services.

It starts by annotating a class with ApiController, which tells the kOS context that this class contains methods to receive HTTP/REST calls.

Since:
1.0
Version:
2022-10-21
  • Annotation Interfaces
    Class
    Description
    ApiController
    Class annotation that indicates that the class contains endpoints.
    ApiEndpoint
    The ApiEndpoint annotation is used to declare and document an HTTP (RESTful) endpoint.
    ApiEndpoint.Param
     
    HandleVariable
    Annotation that binds a method variable to a bean handle.
    PathVariable
    Annotation that binds a method variable to a path parameter.
    RequestBody
    Annotation indicating that the request's body should be parsed in a request mapping and made available in the associated method parameter.
    RequestHeader
    Annotation that binds a method variable to a request header value.
    RequestNodeId
    Annotation that binds a method variable to a request node-id header value.
    RequestParam
    Annotation that binds a method variable to a query parameter.
    Tracker
    Annotation that binds a method parameter to a special tracker variable.