Install #

wget https://endpointelf-releases.nyc3.cdn.digitaloceanspaces.com/dl/EndpointElf_darwin_arm64_v0.3.7.zip

unzip EndpointElf_darwin_arm64_v0.3.7.zip

wget https://endpointelf-releases.nyc3.cdn.digitaloceanspaces.com/dl/EndpointElf_darwin_amd64_v0.3.7.zip

unzip EndpointElf_darwin_amd64_v0.3.7.zip

wget https://endpointelf-releases.nyc3.cdn.digitaloceanspaces.com/dl/EndpointElf_linux_amd64_v0.3.7.zip

unzip EndpointElf_linux_amd64_v0.3.7.zip

wget https://endpointelf-releases.nyc3.cdn.digitaloceanspaces.com/dl/EndpointElf_windows_amd64_v0.3.7.zip

unzip EndpointElf_windows_amd64_v0.3.7.zip

Running EndpointElf #

Once you have EndpointElf on your system you can generate an OpenAPI document from Go code. Run EndpointElf on a directory with HTTP routes.

endpointelf -output api.yaml update ./pkg/api/

time=2024-11-08T22:18:43.585-06:00 level=INFO msg="using AST=true and AI=false engines for update"
time=2024-11-08T22:18:52.409-06:00 level=INFO msg="extracted 5 HTTP routes via AST"

CLI Reference #

endpointelf -help

COMMANDS
  -base base_document.yaml -output api.yaml update <dir>,<dir>,...       Extracts routes from directories of Go source code and updates an OpenAPI document

GLOBAL ARGUMENTS
  -ai=false   Disable using any AI agents/LLMs/etc (Default is to use AI agents)
  -ast=false  Disable using AST parsing engines (Default is to use AST engines)
  -verbose    Enable verbose loggging
  -version    Display the version of EndpointElf and quit