Debugging Steps for Common API Documentation Preview Problems - VeeqoAPI/api-docs GitHub Wiki

Just some common problems during API docs creation that may come in handy when you start.

1. Page doesn't generate successfully, displays no content during preview

It's likely due to a problem with one of the parameters you've specified or an issue with the markdown. Because it makes a request to Apiary to return the preview they will usually return a 400 bad request. Open up network tools to check the /preview request and check the response.

You might see something like the following:

{"statusCode":400,"message":"base type 'integer' is not defined in the document","type":"parseError","location":[{"index":63367,"length":79}],"line":1675,"code":"PARSER_INVALID_INPUT_DOCUMENT"}

(in this example I specified 'integer' as an attribute type, instead of 'number')

The line number it references is the line from the apiary.apib file in the root of the repo.