Skip to content

Generate api-docs for Custom Actuator Endpoint  #786

Closed
@sandeepamilineni

Description

@sandeepamilineni
  • Springdoc can generate api-docs for default endpoints using configuration springdoc.show-actuator=true
    But does not generate api-docs for custom actuator endpoint .
    Custom endpoint example below
@RestControllerEndpoint(id = "tenant")
public class TenantEndpoint {

  @GetMapping("/customer/{id}")
  public String getTenantById(@PathVariable("id") String customerId) {
    return "Tenant_" + customerId;
  }
}
  • What is the actual result using OpenAPI Description (yml or json)?

api-docs-yml.txt

Describe the solution you'd like

  • Generate api-docs for custom Actuator endpoint

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions