How to ignore API

You can use the ignore rule to exclude specific APIs from documentation.

Ignore by annotation

ignore=groovy:it.hasAnn("java.lang.Deprecated")

Ignore by custom annotation

ignore=groovy:it.hasAnn("com.example.IgnoreApi")

Ignore by method name

ignore=groovy:it.name().startsWith("internal")

Example

/**
 * @deprecated use getUserV2 instead
 */
@GetMapping("/user/{id}")
@Deprecated
public User getUser(@PathVariable Long id) {
    // This API will be ignored
}