ApiMethod (Camel :: SPI Annotations 3.21.3 API)

@Retention(RUNTIME)
@Documented
@Target(FIELD)
public @interface ApiMethod

Represents an API method as part of a parent API.

Required Element Summary

Required Elements
Modifier and Type Required Element Description

String methodName
The name of the api method.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`String`	`description`	Returns a description of this api method or api parameter.
`String[]`	`signatures`	Returns the method signature(s) of this api method.

- Element Detail
  - methodName
```
String methodName
```
    The name of the api method.
- - signatures
```
String[] signatures
```
    Returns the method signature(s) of this api method. A method may have one or more signatures due to overloaded methods.
    This is used for documentation and tooling only.
    
    Default:
    
    {""}
- - description
```
String description
```
    Returns a description of this api method or api parameter.
    This is used for documentation and tooling only.
    
    Default:
    
    ""