Adding support for APIs in definition file. #72
Conversation
test/cli-test.js
Outdated
| @@ -100,6 +100,21 @@ describe('command line interface', function () { | |||
| }); | |||
| }); | |||
|
|
|||
| it('should create swagger.json by default when the API input is from definition file', function (done) { | |||
| var goodInput = process.env.PWD + '/bin/swagger-jsdoc.js -d test/fixtures/api_definition.js example/routes.js'; | |||
There was a problem hiding this comment.
I think you mean "/bin/swagger-jsdoc.js -d test/fixtures/api_definition.js" :)
As far as I understand, the pull is to remove the required flag of this input. I tested locally and it's ok!
Could you please also update the docs adding an (optional) and making a short note on the flexibility you introduced?
Really thanks!
|
Fixed! |
README.md
Outdated
| @@ -65,3 +65,13 @@ The swagger spec will be served at http://localhost:3000/api-docs.json | |||
| ### CLI | |||
|
|
|||
| You can also use the tool via [command line interface](./docs/CLI.md). It supports selecting multiple files, recursive subdirectories and watch task for continuous listening of changes in your code. | |||
|
|
|||
| #### CLI Examples | |||
There was a problem hiding this comment.
Better! Only last request from me, please move it to the https://github.com/JesseObrien/swagger-jsdoc/blob/master/docs/CLI.md file which is more specifically for the CLI and just add (optional) to https://github.com/JesseObrien/swagger-jsdoc/blob/master/docs/CLI.md#specify-input-files
Otherwise good work!
|
@drGrove @chdanielmueller if you have some additional ideas, please share. |
|
LGTM after @kalinchernev changes |
|
Alright, should be good now 💃 |
This should add the ability to use the
apikey definition in the definitions file to read file sources for APIs.