apidoc and swagger are two nice projects which are focusing on documentation of APIs. This project is a middle tier which tries to bring them together in a sense that it uses apidoc to convert inline documentation to json schema and later convert it to swagger json schmea.
Please let me recommend to exclude node_modules folder from parsing (-e) by default, as apidoc-swagger tries to parse the third-party code therein and in most of the cases fails with the very unclear messages like error: Undefined error.
Please let me recommend to exclude
node_modules
folder from parsing (-e
) by default, asapidoc-swagger
tries to parse the third-party code therein and in most of the cases fails with the very unclear messages likeerror: Undefined error.