Less intrusive way to make the documentation on an existing API

[amarcadet]

Hi there,

I wanted to know what is the less intrusive way to document my API.
I have a large set of existing routes in subfolders, I'm making an intense use of sub application pattern so my logic is split among several files.
Also I have my own error handling system, so what will happen if I don't use swagger.errors.*?

It looks like discoverFile as some magic that I can use, I just wanted to know if it's the best way.

Last but not least, there is no activity on the master for the past 5 months, is this project still active?

Thanks,
Antoine

[paulhill]

Not dead yet. I have many updates in the works. They bring swagger-node-express in line with the json-schema spec, address issues around form posts, address the ability to customize error handling and response and a lot more. It's my bad for not bringing these changes into the main repo earlier but we have been dog-fooding them in our production API (https://api.kixeye.com/api/v2/docs) and I just haven't got around to it. Will do soon.

[amarcadet]

Thanks for the reply, it looks great.

In fact, I have been looking around for various tools to generate documentation and the best thing would be to have something that can use a notation like https://github.com/apidoc/apidoc mixed with your output that has test capabilities.

Please notify me when your work has been pushed to the master.

Antoine

[paulhill]

Watch the repo and mr github will email you :-)

[fehguy]

hi, take a look at the latest master which allows an easier to add via middleware, and json-schema support.