Record Class ApiDocCatalog

java.lang.Object
java.lang.Record
io.fluxzero.sdk.web.ApiDocCatalog
public record ApiDocCatalog(List<ApiDocEndpoint> endpoints) extends Record
Generic API documentation model extracted from Fluxzero web handlers.

This model is intentionally independent of OpenAPI. Renderers can transform it into OpenAPI or another documentation format.

  • Constructor Details

    • ApiDocCatalog

      public ApiDocCatalog(List<ApiDocEndpoint> endpoints)
      Creates an instance of a ApiDocCatalog record class.
      Parameters:
      endpoints - the value for the endpoints record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • endpoints

      public List<ApiDocEndpoint> endpoints()
      Returns the value of the endpoints record component.
      Returns:
      the value of the endpoints record component