Troubleshoot #

We appreciate you trying out EndpointElf on your projects and are working hard on improving its detection and extraction. Reach out to support@endpointelf.com anytime for help running EndpontElf.

Didn’t Route was not extracted #

Cause: EndpointElf tries several strategies to find and extract HTTP routes, but not all possible paths are covered yet.

Solution:

• Check Syntax: Make sure the route is defined in a recognizable syntax, such as using mux.HandleFunc or http.HandleFunc.
• Open an Issue: Report the issue (with sample code) to EndpointElf’s development team.

Supported Code Currently EndpointElf only supports gorilla/mux for route detection and extraction. We are working to add Go’s standard library net/http and ServeMux support next.

Part of my route was missed or incorrect (e.g., Query Parameters, Path Variables) #

Cause: If route parameters aren’t explicitly documented or are built dynamically, EndpointElf may miss or misinterpret them. EndpointElf may miss some code patterns.

Solution:

• Check Syntax: Make sure the route is defined in a recognizable syntax, such as using mux.HandleFunc or http.HandleFunc.
• Open an Issue: Report the issue (with sample code) to EndpointElf’s development team.

Code Patterns We are rapidly working on improving route detection in EndpointElf following common code patterns. If your project follows a unique coding style it may be harder for EndpointElf to find routes.

The OpenAPI document was invalid, incorrect, or missing details #

Cause: Sometimes, EndpointElf may misinterpret data types if they are defined indirectly or via complex structures in Go.

Solution:

• Specify Data Types Directly: If possible, make the data types in your structs explicit (e.g., string, int) and avoid type aliases that might be confusing.
• Open an Issue: Report the issue (with sample code) to EndpointElf’s development team.

EndpointElf ignores certain files or directories #

Cause: EndpointElf may ignore files or directories that aren’t included in its scanning configuration or are located outside the specified project path.

Solution:

• Verify Scanning Configuration: Ensure that all relevant files are within the paths specified for EndpointElf scanning. Update the config if files were accidentally excluded.
• Check Ignored Patterns: Review EndpointElf’s settings for ignored files and patterns, and adjust them if necessary.
• Open an Issue: Report the issue (with sample code) to EndpointElf’s development team.