Emitting warnings for inconsistent API doc elements

[Lucas-C]

The goal of this PR is to generate warnings for inconsistent API doc comments.

For example, the following comment:

/**
* @api {GET} /resource/:resId/sub/:subId getSubResource
* @apiParam {String} subId
*/

...would trigger this warning:

warn: URL contains a parameter ':resId' that is not documented as @apiParam in @api 'getSubResource' in file: 'api.js'

A warning would also be emitted in case of parameter name mismatch:

/**
* @api {GET} /resource/:resId getSubResource
* @apiParam {String} id
*/

[NicolasCARPi]

Hello, thank you for wanting to contribute to apidoc. Your proposition looks great. Could you please try and add a test case for your new code?

[Lucas-C]

Sure, I have just added a unit test

[Lucas-C]

The GitHub Actions pipeline is ✔️: https://github.com/voyages-sncf-technologies/apidoc/actions/runs/2008326289

[NicolasCARPi]

We could even push further and add a warning if there is an api param that doesn't correspond to anything (so the other way around). Code that would emit a warning:

/**
 * @api {get} /user/:id
 * @apiParam {Number} id user id
 * @apiParam {String} oops some leftover
 */

Would you be willing to add this to your PR?

[Lucas-C]

OK, I also added that check

Pipeline is ✔️: https://github.com/voyages-sncf-technologies/apidoc/actions/runs/2012844549

[NicolasCARPi]

Thanks, great work!

[Lucas-C]

Thank you for maintaining this lib, and for accepting my contribution 😊