Annotation Type RESTService


  • @Retention(RUNTIME)
    @Target(TYPE)
    public @interface RESTService
    REST service method class annotation.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean auth
      Service authentication
      java.lang.String desc
      Service description
      int spec
      Service schema specification, defaults to OpenAPI 3.x
      java.lang.String title
      Service title
      java.lang.String uri
      Service base URI
      java.lang.String version
      Service version
    • Element Detail

      • title

        java.lang.String title
        Service title
        Returns:
        Title
        Default:
        ""
      • desc

        java.lang.String desc
        Service description
        Returns:
        Description
        Default:
        ""
      • uri

        java.lang.String uri
        Service base URI
        Returns:
        Base URI
        Default:
        ""
      • version

        java.lang.String version
        Service version
        Returns:
        Version
        Default:
        ""
      • auth

        boolean auth
        Service authentication
        Returns:
        True if the service requires authentication
        Default:
        true
      • spec

        int spec
        Service schema specification, defaults to OpenAPI 3.x
        Returns:
        JSONTool.OPENAPI_OAS3 (OpenAPI 3.x) or JSONTool.OPENAPI_OAS2 (Swagger 2.x)
        Default:
        3