swagger-jsdoc
Advanced tools
swagger-jsdoc - npm Package Compare versions
Comparing version
| { | ||
| "name": "swagger-jsdoc", | ||
| "version": "1.1.0", | ||
| "version": "1.1.1", | ||
| "description": "Generates swagger doc based on JSDoc", | ||
@@ -30,16 +30,16 @@ "main": "index.js", | ||
| "dependencies": { | ||
| "doctrine": "^0.6.4", | ||
| "js-yaml": "^3.3.1", | ||
| "swagger-parser": "^2.4.2" | ||
| "doctrine": "^0.7.0", | ||
| "js-yaml": "^3.4.2", | ||
| "swagger-parser": "^3.0.1" | ||
| }, | ||
| "devDependencies": { | ||
| "body-parser": "^1.12.4", | ||
| "express": "^4.12.4", | ||
| "istanbul": "^0.3.14", | ||
| "jscs": "^1.13.1", | ||
| "mocha": "^2.2.5", | ||
| "mocha-jscs": "^1.1.0", | ||
| "body-parser": "^1.14.0", | ||
| "express": "^4.13.3", | ||
| "istanbul": "^0.3.21", | ||
| "jscs": "^2.1.1", | ||
| "mocha": "^2.3.3", | ||
| "mocha-jscs": "^3.0.0", | ||
| "mocha-jshint": "^2.2.3", | ||
| "supertest": "^1.0.1" | ||
| "supertest": "^1.1.0" | ||
| } | ||
| } |
@@ -88,2 +88,89 @@ # swagger-jsdoc | ||
| ### Re-using Model Definitions | ||
| A model may be the same for multiple endpoints (Ex. User POST,PUT responses). | ||
| In place of writing (or copy and pasting) the same code into multiple locations, | ||
| which can be error prone when adding a new field to the schema. You can define | ||
| a model and re-use it across multiple endpoints. You can also reference another | ||
| model and add fields. | ||
| ```javascript | ||
| /** | ||
| * @swagger | ||
| * definition: | ||
| * NewUser: | ||
| * type: object | ||
| * required: | ||
| * - username | ||
| * - password | ||
| * properties: | ||
| * username: | ||
| * type: string | ||
| * password: | ||
| * type: string | ||
| * format: password | ||
| * User: | ||
| * allOf: | ||
| * - $ref: '#/definitions/NewUser' | ||
| * - required: | ||
| * - id | ||
| * - properties: | ||
| * id: | ||
| * type: integer | ||
| * format: int64 | ||
| */ | ||
| /** | ||
| * @swagger | ||
| * /users: | ||
| * get: | ||
| * description: Returns users | ||
| * produces: | ||
| * - application/json | ||
| * responses: | ||
| * 200: | ||
| * description: users | ||
| * schema: | ||
| * type: array | ||
| * items: | ||
| * $ref: '#/definitions/User' | ||
| */ | ||
| app.get('/users', function(req, res) { | ||
| res.json([ { | ||
| id: 1, | ||
| username: 'jsmith', | ||
| }, {1 | ||
| id: 2, | ||
| username: 'jdoe', | ||
| } ]); | ||
| }); | ||
| /** | ||
| * @swagger | ||
| * /users: | ||
| * post: | ||
| * description: Returns users | ||
| * produces: | ||
| * - application/json | ||
| * parameters: | ||
| * - name: user | ||
| * description: User object | ||
| * in: body | ||
| * required: true | ||
| * type: string | ||
| * schema: | ||
| * $ref: '#/definitions/NewUser' | ||
| * responses: | ||
| * 200: | ||
| * description: users | ||
| * schema: | ||
| * $ref: '#/definitions/User' | ||
| */ | ||
| app.post('/users', function(req, res) { | ||
| // Generate ID | ||
| req.body.id = Math.floor(Math.random() * 100) * 1 | ||
| res.json(req.body); | ||
| }); | ||
| ``` | ||
| ## Example App | ||
@@ -101,2 +188,2 @@ | ||
| The swagger spec will be served at http://localhost:3000/api-docs.json | ||
| The swagger spec will be served at http://localhost:3000/api-docs.json |
Improved metrics
- Total package byte prevSize
12146
19.29%- Number of lines in readme file
188
88%Dependency changes
+ Added
call-me-maybe@1.0.2(transitive)+ Added
commander@2.20.3(transitive)+ Added
core-js@2.6.12(transitive)+ Added
debug@3.2.7(transitive)+ Added
doctrine@0.7.2(transitive)+ Added
es6-promise@3.3.14.2.8(transitive)+ Added
format-util@1.0.5(transitive)+ Added
json-schema-ref-parser@1.4.1(transitive)+ Added
lodash.get@4.4.2(transitive)+ Added
lodash.isequal@4.5.0(transitive)+ Added
ms@2.1.3(transitive)+ Added
ono@2.2.54.0.11(transitive)+ Added
swagger-methods@1.0.8(transitive)+ Added
swagger-parser@3.4.2(transitive)+ Added
swagger-schema-official@2.0.0-bab6bed(transitive)+ Added
validator@10.11.0(transitive)+ Added
z-schema@3.25.1(transitive)- Removed
doctrine@0.6.4(transitive)- Removed
lodash@3.10.1(transitive)- Removed
swagger-parser@2.5.0(transitive)- Removed
swagger-schema-official@2.0.0-96305d9(transitive)- Removed
tv4@1.3.0(transitive)Updated
doctrine@^0.7.0Updated
js-yaml@^3.4.2Updated
swagger-parser@^3.0.1