Ok, так что я играю с apidocjs, чтобы понять это, прежде чем внедрять его в производственной среде, и я incountering следующее:Apidocjs бросает предупреждения, когда я попытка обновить
~/apidoc_playground$ apidoc
warn: parser plugin 'param' not found in block: 0
info: Done.
являются следующие блок комментарии он смотрит на (каждый в отдельном файле):
/**
*this is a test of apidocjs
*@api {get} /user/:id Request User information
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id Users unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*
*/
/**
*@api {GET} /getPicture/:UID Retreive user profile picture
*@apiGroup User
*@apiName getPicture
*@apiVersion 0.0.1
*
*@apiDescription userID goes in, picture comes out, you can't explain that!
*@apiParam {int} UID User's identification number.
*@apiExample {curl} Example usage:
* curl -i http://api.example.com/getPicture/45123
*@apiSuccess (200) {json} picture The user's profile picture
*@apiError (4xx) {userNotFound} UID There was no user affiliated with the given id.
*@apiErrorExample {json} Error-Response:
* HTTP/1.1 404 Not Found
* {
* "error":"UserNotFound"
* }
*/
Что я уже знаю:
Это не вызывает обновление потерпеть неудачу, apidoc обновляет выходной адр как предполагалось.
Если я удалю выходной каталог перед вызовом apidoc, нет предупреждения.
предупреждение все еще происходит, если у него нет файлов для разбора.
после чистки для ответа, я могу найти один question, который похож на мой, за исключением того, что у аскера также есть ошибки формата в его apidoc.json. При этом ответы в этом потоке действительно не соответствуют тому, что я ищу (один из них удаляет папку вывода перед вызовом apidoc, а другой не удаляет выходную папку, если вы хотите сохранить историю и, возможно, у вас ошибки формата).
Любые идеи более опытных пользователей apidocjs будут определены.
извините за стену из-текста
Вы знаете, как сканировать только определенные файлы? например, если у вас есть папка с 100 файлами .js, и вы хотите только сканировать server.js и app.js, вы знаете, как это сделать? – user1010101