swagger-inline-hkloudoufix
- Fork From https://github.com/readmeio/swagger-inline/
- Fix Some Bug
Node module for extracting swagger endpoints from inline comments.
Install
npm install --save-dev swagger-inline-hkloudoufix
sudo npm install -g swagger-inline-hkloudoufix
Build
npm run build # single build npm start # build + watch
Test
npm test # single run npm run test-watch # test + watch
Usage
Javascript
swaggerInline([inputGlobs...], options) => Promise => json | yaml
const swaggerInline = ; ;
Cli
swagger-inline <inputGlobs ...> [--base] [--format] [--out]
swagger-inline 'src/**/*.js' --base 'swaggerBase.json' # outputs built swagger.json
Options:
inputGlobs
: Files/globs to search for swagger comments.base
: Base swagger to extend. (default: auto-detect)out
: Name of file to output the generated swagger file (default: results returned, no file saved).format
: Output filetype -.json
or.yaml
(default:.json
)logger
: Function called for logging.metadata
: Add additional annotations to the Swagger file, prefixed with "x-si"ignore
: globs of files to ignore (by default,['node_modules/**/*', ...etc]
,
Example:
1) Create a project
swaggerBase.yaml
swagger: "2.0"host: "petstore.swagger.io"basePath: "/api"schemes: ['http']
api.js
/* * @api [get] /pets * description: "Returns all pets from the system that the user has access to" * responses: * "200": * description: "A list of pets." * schema: * type: "String" */ api;
2) Run Command
swagger-inline './*.js' --base './swaggerBase.yaml'
Output:
swagger.yaml
swagger: "2.0"host: "petstore.swagger.io"basePath: "/api"schemes: ['http']/pets: get: description: Returns all pets from the system that the user has access to responses: '200': description: A list of pets. schema: type: "String"