Debugging

Drop the debug internal template anywhere to see how data flows. Follow the activity of the console..

In addition to see what is going on in the API you are getting the data from, there is a couple of things you can do to have a healthy debugging session.

Add the debug template

API2HTML comes with an internal template that you can reference in any of your templates to see the debug. Only if the server has been started with the -d flag you will be able to see it. Try it now:

{{ >api2html/debug }}

Save your template with this new line and restart the service. The debug will show you all the information related to:

• Request context
• Backend full response (both object or array)
• Extra data available in this route

In the api2html repository there is also a debugger example that you can try:

cd examples
api2html serve -d -c config.json -p 8080

Keep an eye to the console

Start the server and keep coming back to read the output. This will give you valuable information to understand what is going on. Some of the things you can see in the stdout are:

• Known routes
  • All paths the service knows how to process
  • Variables in the route (/route/:var)
  • Go handlers for each route
• Information about requests and responses
  • Status codes
  • Error messages
  • Originating IP
  • Methods
  • Time to serve

---

Continue to Common problems →

← Back to Hot reload