From 1f35f58841c71f3d943af63f32773907de1aff23 Mon Sep 17 00:00:00 2001 From: wing328 Date: Thu, 9 Jul 2015 14:05:08 +0800 Subject: [PATCH] add back summary and description to nodejs swagger.json --- .../main/resources/nodejs/swagger.mustache | 8 +- .../server/petstore/nodejs/api/swagger.json | 1385 ++++++++++------- .../server/petstore/nodejs/controllers/Pet.js | 170 +- .../petstore/nodejs/controllers/PetService.js | 164 +- .../petstore/nodejs/controllers/Store.js | 78 +- .../nodejs/controllers/StoreService.js | 90 +- .../petstore/nodejs/controllers/User.js | 162 +- .../nodejs/controllers/UserService.js | 94 +- samples/server/petstore/nodejs/index.js | 32 +- samples/server/petstore/nodejs/package.json | 4 +- 10 files changed, 1250 insertions(+), 937 deletions(-) diff --git a/modules/swagger-codegen/src/main/resources/nodejs/swagger.mustache b/modules/swagger-codegen/src/main/resources/nodejs/swagger.mustache index 8b4c8d33bdc..e4254fd0aa4 100644 --- a/modules/swagger-codegen/src/main/resources/nodejs/swagger.mustache +++ b/modules/swagger-codegen/src/main/resources/nodejs/swagger.mustache @@ -15,17 +15,17 @@ {{#operation}} "{{{path}}}": { "{{httpMethod}}": { + "summary": "{{summary}}", + "description":"{{notes}}", "x-swagger-router-controller": "{{classname}}", "tags": ["{{baseName}}"], "operationId": "{{operationId}}",{{#hasParams}} "parameters": [ - {{#allParams}} - {{{jsonSchema}}}{{#hasMore}},{{/hasMore}} + {{#allParams}}{{{jsonSchema}}}{{#hasMore}},{{/hasMore}} {{/allParams}} ],{{/hasParams}} "responses": { - {{#responses}} - "{{code}}": {{{jsonSchema}}} + {{#responses}}"{{code}}": {{{jsonSchema}}} {{#hasMore}},{{/hasMore}} {{/responses}} } diff --git a/samples/server/petstore/nodejs/api/swagger.json b/samples/server/petstore/nodejs/api/swagger.json index 6880eb18684..02c5ca0f97f 100644 --- a/samples/server/petstore/nodejs/api/swagger.json +++ b/samples/server/petstore/nodejs/api/swagger.json @@ -2,558 +2,851 @@ "swagger": "2.0", "info": { "title": "Swagger Petstore", - "description": "This is a sample server Petstore server. You can find out more about Swagger at <a href="http://swagger.io">http://swagger.io</a> or on irc.freenode.net, #swagger. For this sample, you can use the api key "special-key" to test the authorization filters", + "description": "This is a sample server Petstore server. You can find out more about Swagger at <a href=\"http://swagger.io\">http://swagger.io</a> or on irc.freenode.net, #swagger. For this sample, you can use the api key \"special-key\" to test the authorization filters", "version": "1.0.0" }, - "produces": [ - "application/json" - ], + "produces": ["application/json"], "host": "localhost:8080", "basePath": "/v2", "paths": { - "/user": { - "post": { - "x-swagger-router-controller": "User", - "tags": [ - "User" - ], - "operationId": "createUser", - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Created user object", - "required": false, - "schema": { - "$ref": "#/definitions/User" - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/createWithArray": { - "post": { - "x-swagger-router-controller": "User", - "tags": [ - "User" - ], - "operationId": "createUsersWithArrayInput", - "parameters": [ - { - "in": "body", - "name": "body", - "description": "List of user object", - "required": false, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/User" - } - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/createWithList": { - "post": { - "x-swagger-router-controller": "User", - "tags": [ - "User" - ], - "operationId": "createUsersWithListInput", - "parameters": [ - { - "in": "body", - "name": "body", - "description": "List of user object", - "required": false, - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/User" - } - } - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/login": { - "get": { - "x-swagger-router-controller": "User", - "tags": [ - "User" - ], - "operationId": "loginUser", - "parameters": [ - { - "name": "username", - "in": "query", - "description": "The user name for login", - "required": false, - "type": "string" - }, - { - "name": "password", - "in": "query", - "description": "The password for login in clear text", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "string" - } - }, - "400": { - "description": "Invalid username/password supplied" - } - } - } - }, - "/user/logout": { - "get": { - "x-swagger-router-controller": "User", - "tags": [ - "User" - ], - "operationId": "logoutUser", - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/user/{username}": { - "delete": { - "x-swagger-router-controller": "User", - "tags": [ - "User" - ], - "operationId": "deleteUser", - "parameters": [ - { - "name": "username", - "in": "path", - "description": "The name that needs to be deleted", - "required": true, - "type": "string" - } - ], - "responses": { - "404": { - "description": "User not found" - }, - "400": { - "description": "Invalid username supplied" - } - } - } - }, - "/pet": { - "post": { - "x-swagger-router-controller": "Pet", - "tags": [ - "Pet" - ], - "operationId": "addPet", - "parameters": [ - { - "in": "body", - "name": "body", - "description": "Pet object that needs to be added to the store", - "required": false, - "schema": { - "$ref": "#/definitions/Pet" - } - } - ], - "responses": { - "405": { - "description": "Invalid input" - } - } - } - }, - "/pet/findByStatus": { - "get": { - "x-swagger-router-controller": "Pet", - "tags": [ - "Pet" - ], - "operationId": "findPetsByStatus", - "parameters": [ - { - "name": "status", - "in": "query", - "description": "Status values that need to be considered for filter", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi", - "default": "available" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Pet" - } - } - }, - "400": { - "description": "Invalid status value" - } - } - } - }, - "/pet/findByTags": { - "get": { - "x-swagger-router-controller": "Pet", - "tags": [ - "Pet" - ], - "operationId": "findPetsByTags", - "parameters": [ - { - "name": "tags", - "in": "query", - "description": "Tags to filter by", - "required": false, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Pet" - } - } - }, - "400": { - "description": "Invalid tag value" - } - } - } - }, - "/pet/{petId}": { - "delete": { - "x-swagger-router-controller": "Pet", - "tags": [ - "Pet" - ], - "operationId": "deletePet", - "parameters": [ - { - "name": "api_key", - "in": "header", - "description": "", - "required": false, - "type": "string" - }, - { - "name": "petId", - "in": "path", - "description": "Pet id to delete", - "required": true, - "type": "integer", - "format": "int64" - } - ], - "responses": { - "400": { - "description": "Invalid pet value" - } - } - } - }, - "/pet/{petId}/uploadImage": { - "post": { - "x-swagger-router-controller": "Pet", - "tags": [ - "Pet" - ], - "operationId": "uploadFile", - "parameters": [ - { - "name": "petId", - "in": "path", - "description": "ID of pet to update", - "required": true, - "type": "integer", - "format": "int64" - }, - { - "name": "additionalMetadata", - "in": "formData", - "description": "Additional data to pass to server", - "required": false, - "type": "string" - }, - { - "name": "file", - "in": "formData", - "description": "file to upload", - "required": false, - "type": "file" - } - ], - "responses": { - "default": { - "description": "successful operation" - } - } - } - }, - "/store/inventory": { - "get": { - "x-swagger-router-controller": "Store", - "tags": [ - "Store" - ], - "operationId": "getInventory", - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "object", - "additionalProperties": { - "type": "integer", - "format": "int32" - } - } - } - } - } - }, - "/store/order": { - "post": { - "x-swagger-router-controller": "Store", - "tags": [ - "Store" - ], - "operationId": "placeOrder", - "parameters": [ - { - "in": "body", - "name": "body", - "description": "order placed for purchasing the pet", - "required": false, - "schema": { - "$ref": "#/definitions/Order" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Order" - } - }, - "400": { - "description": "Invalid Order" - } - } - } - }, - "/store/order/{orderId}": { - "delete": { - "x-swagger-router-controller": "Store", - "tags": [ - "Store" - ], - "operationId": "deleteOrder", - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "ID of the order that needs to be deleted", - "required": true, - "type": "string" - } - ], - "responses": { - "404": { - "description": "Order not found" - }, - "400": { - "description": "Invalid ID supplied" - } - } + + "/user": { + "post": { + "summary": "Create user", + "description":"This can only be done by the logged in user.", + "x-swagger-router-controller": "User", + "tags": ["User"], + "operationId": "createUser", + "parameters": [ + { + "in" : "body", + "name" : "body", + "description" : "Created user object", + "required" : false, + "schema" : { + "$ref" : "#/definitions/User" + } +} + + ], + "responses": { + "default": { + "description" : "successful operation" +} + + } } - }, - "definitions": { - "User": { - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "username": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "email": { - "type": "string" - }, - "password": { - "type": "string" - }, - "phone": { - "type": "string" - }, - "userStatus": { - "type": "integer", - "format": "int32", - "description": "User Status" - } - }, - "xml": { - "name": "User" - } - }, - "Category": { - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "xml": { - "name": "Category" - } - }, - "Pet": { - "required": [ - "name", - "photoUrls" - ], - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "category": { - "$ref": "#/definitions/Category" - }, - "name": { - "type": "string", - "example": "doggie" - }, - "photoUrls": { - "type": "array", - "items": { - "type": "string" - } - }, - "tags": { - "type": "array", - "items": { - "$ref": "#/definitions/Tag" - } - }, - "status": { - "type": "string", - "description": "pet status in the store", - "enum": [ - "available", - "pending", - "sold" - ] - } - }, - "xml": { - "name": "Pet" - } - }, - "Tag": { - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "xml": { - "name": "Tag" - } - }, - "Order": { - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "petId": { - "type": "integer", - "format": "int64" - }, - "quantity": { - "type": "integer", - "format": "int32" - }, - "shipDate": { - "type": "string", - "format": "date-time" - }, - "status": { - "type": "string", - "description": "Order Status", - "enum": [ - "placed", - "approved", - "delivered" - ] - }, - "complete": { - "type": "boolean" - } - }, - "xml": { - "name": "Order" - } + } , + + "/user/createWithArray": { + "post": { + "summary": "Creates list of users with given input array", + "description":"", + "x-swagger-router-controller": "User", + "tags": ["User"], + "operationId": "createUsersWithArrayInput", + "parameters": [ + { + "in" : "body", + "name" : "body", + "description" : "List of user object", + "required" : false, + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/User" } } -} \ No newline at end of file +} + + ], + "responses": { + "default": { + "description" : "successful operation" +} + + + } + } + } , + + "/user/createWithList": { + "post": { + "summary": "Creates list of users with given input array", + "description":"", + "x-swagger-router-controller": "User", + "tags": ["User"], + "operationId": "createUsersWithListInput", + "parameters": [ + { + "in" : "body", + "name" : "body", + "description" : "List of user object", + "required" : false, + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/User" + } + } +} + + ], + "responses": { + "default": { + "description" : "successful operation" +} + + + } + } + } , + + "/user/login": { + "get": { + "summary": "Logs user into the system", + "description":"", + "x-swagger-router-controller": "User", + "tags": ["User"], + "operationId": "loginUser", + "parameters": [ + { + "name" : "username", + "in" : "query", + "description" : "The user name for login", + "required" : false, + "type" : "string" +}, + { + "name" : "password", + "in" : "query", + "description" : "The password for login in clear text", + "required" : false, + "type" : "string" +} + + ], + "responses": { + "200": { + "description" : "successful operation", + "schema" : { + "type" : "string" + } +} + , + "400": { + "description" : "Invalid username/password supplied" +} + + + } + } + } , + + "/user/logout": { + "get": { + "summary": "Logs out current logged in user session", + "description":"", + "x-swagger-router-controller": "User", + "tags": ["User"], + "operationId": "logoutUser", + "responses": { + "default": { + "description" : "successful operation" +} + + + } + } + } , + + "/user/{username}": { + "get": { + "summary": "Get user by user name", + "description":"", + "x-swagger-router-controller": "User", + "tags": ["User"], + "operationId": "getUserByName", + "parameters": [ + { + "name" : "username", + "in" : "path", + "description" : "The name that needs to be fetched. Use user1 for testing. ", + "required" : true, + "type" : "string" +} + + ], + "responses": { + "404": { + "description" : "User not found" +} + , + "200": { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/User" + }, + "examples" : { + "application/json" : { + "id" : 1, + "username" : "johnp", + "firstName" : "John", + "lastName" : "Public", + "email" : "johnp@swagger.io", + "password" : "-secret-", + "phone" : "0123456789", + "userStatus" : 0 + } + } +} + , + "400": { + "description" : "Invalid username supplied" +} + + + } + } + } , + + "/user/{username}": { + "put": { + "summary": "Updated user", + "description":"This can only be done by the logged in user.", + "x-swagger-router-controller": "User", + "tags": ["User"], + "operationId": "updateUser", + "parameters": [ + { + "name" : "username", + "in" : "path", + "description" : "name that need to be deleted", + "required" : true, + "type" : "string" +}, + { + "in" : "body", + "name" : "body", + "description" : "Updated user object", + "required" : false, + "schema" : { + "$ref" : "#/definitions/User" + } +} + + ], + "responses": { + "404": { + "description" : "User not found" +} + , + "400": { + "description" : "Invalid user supplied" +} + + + } + } + } , + + "/user/{username}": { + "delete": { + "summary": "Delete user", + "description":"This can only be done by the logged in user.", + "x-swagger-router-controller": "User", + "tags": ["User"], + "operationId": "deleteUser", + "parameters": [ + { + "name" : "username", + "in" : "path", + "description" : "The name that needs to be deleted", + "required" : true, + "type" : "string" +} + + ], + "responses": { + "404": { + "description" : "User not found" +} + , + "400": { + "description" : "Invalid username supplied" +} + + + } + } + } + + , + + "/pet": { + "put": { + "summary": "Update an existing pet", + "description":"", + "x-swagger-router-controller": "Pet", + "tags": ["Pet"], + "operationId": "updatePet", + "parameters": [ + { + "in" : "body", + "name" : "body", + "description" : "Pet object that needs to be added to the store", + "required" : false, + "schema" : { + "$ref" : "#/definitions/Pet" + } +} + + ], + "responses": { + "405": { + "description" : "Validation exception" +} + , + "404": { + "description" : "Pet not found" +} + , + "400": { + "description" : "Invalid ID supplied" +} + + + } + } + } , + + "/pet": { + "post": { + "summary": "Add a new pet to the store", + "description":"", + "x-swagger-router-controller": "Pet", + "tags": ["Pet"], + "operationId": "addPet", + "parameters": [ + { + "in" : "body", + "name" : "body", + "description" : "Pet object that needs to be added to the store", + "required" : false, + "schema" : { + "$ref" : "#/definitions/Pet" + } +} + + ], + "responses": { + "405": { + "description" : "Invalid input" +} + + + } + } + } , + + "/pet/findByStatus": { + "get": { + "summary": "Finds Pets by status", + "description":"Multiple status values can be provided with comma seperated strings", + "x-swagger-router-controller": "Pet", + "tags": ["Pet"], + "operationId": "findPetsByStatus", + "parameters": [ + { + "name" : "status", + "in" : "query", + "description" : "Status values that need to be considered for filter", + "required" : false, + "type" : "array", + "items" : { + "type" : "string" + }, + "collectionFormat" : "multi", + "default" : "available" +} + + ], + "responses": { + "200": { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Pet" + } + } +} + , + "400": { + "description" : "Invalid status value" +} + + + } + } + } , + + "/pet/findByTags": { + "get": { + "summary": "Finds Pets by tags", + "description":"Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.", + "x-swagger-router-controller": "Pet", + "tags": ["Pet"], + "operationId": "findPetsByTags", + "parameters": [ + { + "name" : "tags", + "in" : "query", + "description" : "Tags to filter by", + "required" : false, + "type" : "array", + "items" : { + "type" : "string" + }, + "collectionFormat" : "multi" +} + + ], + "responses": { + "200": { + "description" : "successful operation", + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Pet" + } + } +} + , + "400": { + "description" : "Invalid tag value" +} + + + } + } + } , + + "/pet/{petId}": { + "get": { + "summary": "Find pet by ID", + "description":"Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions", + "x-swagger-router-controller": "Pet", + "tags": ["Pet"], + "operationId": "getPetById", + "parameters": [ + { + "name" : "petId", + "in" : "path", + "description" : "ID of pet that needs to be fetched", + "required" : true, + "type" : "integer", + "format" : "int64" +} + + ], + "responses": { + "404": { + "description" : "Pet not found" +} + , + "200": { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Pet" + } +} + , + "400": { + "description" : "Invalid ID supplied" +} + + + } + } + } , + + "/pet/{petId}": { + "post": { + "summary": "Updates a pet in the store with form data", + "description":"", + "x-swagger-router-controller": "Pet", + "tags": ["Pet"], + "operationId": "updatePetWithForm", + "parameters": [ + { + "name" : "petId", + "in" : "path", + "description" : "ID of pet that needs to be updated", + "required" : true, + "type" : "string" +}, + { + "name" : "name", + "in" : "formData", + "description" : "Updated name of the pet", + "required" : false, + "type" : "string" +}, + { + "name" : "status", + "in" : "formData", + "description" : "Updated status of the pet", + "required" : false, + "type" : "string" +} + + ], + "responses": { + "405": { + "description" : "Invalid input" +} + + + } + } + } , + + "/pet/{petId}": { + "delete": { + "summary": "Deletes a pet", + "description":"", + "x-swagger-router-controller": "Pet", + "tags": ["Pet"], + "operationId": "deletePet", + "parameters": [ + { + "name" : "api_key", + "in" : "header", + "description" : "", + "required" : false, + "type" : "string" +}, + { + "name" : "petId", + "in" : "path", + "description" : "Pet id to delete", + "required" : true, + "type" : "integer", + "format" : "int64" +} + + ], + "responses": { + "400": { + "description" : "Invalid pet value" +} + + + } + } + } , + + "/pet/{petId}/uploadImage": { + "post": { + "summary": "uploads an image", + "description":"", + "x-swagger-router-controller": "Pet", + "tags": ["Pet"], + "operationId": "uploadFile", + "parameters": [ + { + "name" : "petId", + "in" : "path", + "description" : "ID of pet to update", + "required" : true, + "type" : "integer", + "format" : "int64" +}, + { + "name" : "additionalMetadata", + "in" : "formData", + "description" : "Additional data to pass to server", + "required" : false, + "type" : "string" +}, + { + "name" : "file", + "in" : "formData", + "description" : "file to upload", + "required" : false, + "type" : "file" +} + + ], + "responses": { + "default": { + "description" : "successful operation" +} + + + } + } + } + + , + + "/store/inventory": { + "get": { + "summary": "Returns pet inventories by status", + "description":"Returns a map of status codes to quantities", + "x-swagger-router-controller": "Store", + "tags": ["Store"], + "operationId": "getInventory", + "responses": { + "200": { + "description" : "successful operation", + "schema" : { + "type" : "object", + "additionalProperties" : { + "type" : "integer", + "format" : "int32" + } + } +} + + + } + } + } , + + "/store/order": { + "post": { + "summary": "Place an order for a pet", + "description":"", + "x-swagger-router-controller": "Store", + "tags": ["Store"], + "operationId": "placeOrder", + "parameters": [ + { + "in" : "body", + "name" : "body", + "description" : "order placed for purchasing the pet", + "required" : false, + "schema" : { + "$ref" : "#/definitions/Order" + } +} + + ], + "responses": { + "200": { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Order" + } +} + , + "400": { + "description" : "Invalid Order" +} + + + } + } + } , + + "/store/order/{orderId}": { + "get": { + "summary": "Find purchase order by ID", + "description":"For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions", + "x-swagger-router-controller": "Store", + "tags": ["Store"], + "operationId": "getOrderById", + "parameters": [ + { + "name" : "orderId", + "in" : "path", + "description" : "ID of pet that needs to be fetched", + "required" : true, + "type" : "string" +} + + ], + "responses": { + "404": { + "description" : "Order not found" +} + , + "200": { + "description" : "successful operation", + "schema" : { + "$ref" : "#/definitions/Order" + } +} + , + "400": { + "description" : "Invalid ID supplied" +} + + + } + } + } , + + "/store/order/{orderId}": { + "delete": { + "summary": "Delete purchase order by ID", + "description":"For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors", + "x-swagger-router-controller": "Store", + "tags": ["Store"], + "operationId": "deleteOrder", + "parameters": [ + { + "name" : "orderId", + "in" : "path", + "description" : "ID of the order that needs to be deleted", + "required" : true, + "type" : "string" +} + + ], + "responses": { + "404": { + "description" : "Order not found" +} + , + "400": { + "description" : "Invalid ID supplied" +} + + + } + } + } + + + }, "definitions": { + "User": { + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "username" : { + "type" : "string" + }, + "firstName" : { + "type" : "string" + }, + "lastName" : { + "type" : "string" + }, + "email" : { + "type" : "string" + }, + "password" : { + "type" : "string" + }, + "phone" : { + "type" : "string" + }, + "userStatus" : { + "type" : "integer", + "format" : "int32", + "description" : "User Status" + } + }, + "xml" : { + "name" : "User" + } +},"Category": { + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + } + }, + "xml" : { + "name" : "Category" + } +},"Pet": { + "required" : [ "name", "photoUrls" ], + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "category" : { + "$ref" : "#/definitions/Category" + }, + "name" : { + "type" : "string", + "example" : "doggie" + }, + "photoUrls" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "tags" : { + "type" : "array", + "items" : { + "$ref" : "#/definitions/Tag" + } + }, + "status" : { + "type" : "string", + "description" : "pet status in the store", + "enum" : [ "available", "pending", "sold" ] + } + }, + "xml" : { + "name" : "Pet" + } +},"Tag": { + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "name" : { + "type" : "string" + } + }, + "xml" : { + "name" : "Tag" + } +},"Order": { + "properties" : { + "id" : { + "type" : "integer", + "format" : "int64" + }, + "petId" : { + "type" : "integer", + "format" : "int64" + }, + "quantity" : { + "type" : "integer", + "format" : "int32" + }, + "shipDate" : { + "type" : "string", + "format" : "date-time" + }, + "status" : { + "type" : "string", + "description" : "Order Status", + "enum" : [ "placed", "approved", "delivered" ] + }, + "complete" : { + "type" : "boolean" + } + }, + "xml" : { + "name" : "Order" + } +} + } +} diff --git a/samples/server/petstore/nodejs/controllers/Pet.js b/samples/server/petstore/nodejs/controllers/Pet.js index b96815e4860..f23f593f414 100644 --- a/samples/server/petstore/nodejs/controllers/Pet.js +++ b/samples/server/petstore/nodejs/controllers/Pet.js @@ -6,119 +6,119 @@ var url = require('url'); var Pet = require('./PetService'); -module.exports.updatePet = function updatePet(req, res, next) { - var body = req.swagger.params['body'].value; +module.exports.updatePet = function updatePet (req, res, next) { + var body = req.swagger.params['body'].value; + + var result = Pet.updatePet(body); - var result = Pet.updatePet(body); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.addPet = function addPet(req, res, next) { - var body = req.swagger.params['body'].value; +module.exports.addPet = function addPet (req, res, next) { + var body = req.swagger.params['body'].value; + + var result = Pet.addPet(body); - var result = Pet.addPet(body); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.findPetsByStatus = function findPetsByStatus(req, res, next) { - var status = req.swagger.params['status'].value; +module.exports.findPetsByStatus = function findPetsByStatus (req, res, next) { + var status = req.swagger.params['status'].value; + + var result = Pet.findPetsByStatus(status); - var result = Pet.findPetsByStatus(status); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.findPetsByTags = function findPetsByTags(req, res, next) { - var tags = req.swagger.params['tags'].value; +module.exports.findPetsByTags = function findPetsByTags (req, res, next) { + var tags = req.swagger.params['tags'].value; + + var result = Pet.findPetsByTags(tags); - var result = Pet.findPetsByTags(tags); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.getPetById = function getPetById(req, res, next) { - var petId = req.swagger.params['petId'].value; +module.exports.getPetById = function getPetById (req, res, next) { + var petId = req.swagger.params['petId'].value; + + var result = Pet.getPetById(petId); - var result = Pet.getPetById(petId); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.updatePetWithForm = function updatePetWithForm(req, res, next) { - var petId = req.swagger.params['petId'].value; - var name = req.swagger.params['name'].value; - var status = req.swagger.params['status'].value; +module.exports.updatePetWithForm = function updatePetWithForm (req, res, next) { + var petId = req.swagger.params['petId'].value; + var name = req.swagger.params['name'].value; + var status = req.swagger.params['status'].value; + + var result = Pet.updatePetWithForm(petId, name, status); - var result = Pet.updatePetWithForm(petId, name, status); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.deletePet = function deletePet(req, res, next) { - var api_key = req.swagger.params['api_key'].value; - var petId = req.swagger.params['petId'].value; +module.exports.deletePet = function deletePet (req, res, next) { + var apiKey = req.swagger.params['api_key'].value; + var petId = req.swagger.params['petId'].value; + + var result = Pet.deletePet(apiKey, petId); - var result = Pet.deletePet(api_key, petId); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.uploadFile = function uploadFile(req, res, next) { - var petId = req.swagger.params['petId'].value; - var additionalMetadata = req.swagger.params['additionalMetadata'].value; - var file = req.swagger.params['file'].value; +module.exports.uploadFile = function uploadFile (req, res, next) { + var petId = req.swagger.params['petId'].value; + var additionalMetadata = req.swagger.params['additionalMetadata'].value; + var file = req.swagger.params['file'].value; + + var result = Pet.uploadFile(petId, additionalMetadata, file); - var result = Pet.uploadFile(petId, additionalMetadata, file); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; diff --git a/samples/server/petstore/nodejs/controllers/PetService.js b/samples/server/petstore/nodejs/controllers/PetService.js index 8e7eaaac090..cdfac3466ae 100644 --- a/samples/server/petstore/nodejs/controllers/PetService.js +++ b/samples/server/petstore/nodejs/controllers/PetService.js @@ -1,104 +1,112 @@ 'use strict'; -exports.updatePet = function (body) { - - var examples = {}; +exports.updatePet = function(body) { + var examples = {}; + + } -exports.addPet = function (body) { - - var examples = {}; +exports.addPet = function(body) { + var examples = {}; + + } -exports.findPetsByStatus = function (status) { +exports.findPetsByStatus = function(status) { - var examples = {}; - - examples['application/json'] = [{ - "tags": [{ - "id": 123456789, - "name": "aeiou" - }], - "id": 123456789, - "category": { - "id": 123456789, - "name": "aeiou" - }, - "status": "aeiou", - "name": "doggie", - "photoUrls": ["aeiou"] - }]; - - - if (Object.keys(examples).length > 0) - return examples[Object.keys(examples)[0]]; + var examples = {}; + + examples['application/json'] = [ { + "tags" : [ { + "id" : 123456789, + "name" : "aeiou" + } ], + "id" : 123456789, + "category" : { + "id" : 123456789, + "name" : "aeiou" + }, + "status" : "aeiou", + "name" : "doggie", + "photoUrls" : [ "aeiou" ] +} ]; + + + if(Object.keys(examples).length > 0) + return examples[Object.keys(examples)[0]]; + } -exports.findPetsByTags = function (tags) { +exports.findPetsByTags = function(tags) { - var examples = {}; - - examples['application/json'] = [{ - "tags": [{ - "id": 123456789, - "name": "aeiou" - }], - "id": 123456789, - "category": { - "id": 123456789, - "name": "aeiou" - }, - "status": "aeiou", - "name": "doggie", - "photoUrls": ["aeiou"] - }]; - - - if (Object.keys(examples).length > 0) - return examples[Object.keys(examples)[0]]; + var examples = {}; + + examples['application/json'] = [ { + "tags" : [ { + "id" : 123456789, + "name" : "aeiou" + } ], + "id" : 123456789, + "category" : { + "id" : 123456789, + "name" : "aeiou" + }, + "status" : "aeiou", + "name" : "doggie", + "photoUrls" : [ "aeiou" ] +} ]; + + + if(Object.keys(examples).length > 0) + return examples[Object.keys(examples)[0]]; + } -exports.getPetById = function (petId) { +exports.getPetById = function(petId) { - var examples = {}; - - examples['application/json'] = { - "tags": [{ - "id": 123456789, - "name": "aeiou" - }], - "id": 123456789, - "category": { - "id": 123456789, - "name": "aeiou" - }, - "status": "aeiou", - "name": "doggie", - "photoUrls": ["aeiou"] - }; - - - if (Object.keys(examples).length > 0) - return examples[Object.keys(examples)[0]]; + var examples = {}; + + examples['application/json'] = { + "tags" : [ { + "id" : 123456789, + "name" : "aeiou" + } ], + "id" : 123456789, + "category" : { + "id" : 123456789, + "name" : "aeiou" + }, + "status" : "aeiou", + "name" : "doggie", + "photoUrls" : [ "aeiou" ] +}; + + + if(Object.keys(examples).length > 0) + return examples[Object.keys(examples)[0]]; + } -exports.updatePetWithForm = function (petId, name, status) { - - var examples = {}; +exports.updatePetWithForm = function(petId, name, status) { + var examples = {}; + + } -exports.deletePet = function (api_key, petId) { - - var examples = {}; +exports.deletePet = function(apiKey, petId) { + var examples = {}; + + } -exports.uploadFile = function (petId, additionalMetadata, file) { - - var examples = {}; +exports.uploadFile = function(petId, additionalMetadata, file) { + var examples = {}; + + } diff --git a/samples/server/petstore/nodejs/controllers/Store.js b/samples/server/petstore/nodejs/controllers/Store.js index fe00af26cc5..7059f9afa61 100644 --- a/samples/server/petstore/nodejs/controllers/Store.js +++ b/samples/server/petstore/nodejs/controllers/Store.js @@ -6,57 +6,57 @@ var url = require('url'); var Store = require('./StoreService'); -module.exports.getInventory = function getInventory(req, res, next) { +module.exports.getInventory = function getInventory (req, res, next) { + + var result = Store.getInventory(); - var result = Store.getInventory(); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.placeOrder = function placeOrder(req, res, next) { - var body = req.swagger.params['body'].value; +module.exports.placeOrder = function placeOrder (req, res, next) { + var body = req.swagger.params['body'].value; + + var result = Store.placeOrder(body); - var result = Store.placeOrder(body); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.getOrderById = function getOrderById(req, res, next) { - var orderId = req.swagger.params['orderId'].value; +module.exports.getOrderById = function getOrderById (req, res, next) { + var orderId = req.swagger.params['orderId'].value; + + var result = Store.getOrderById(orderId); - var result = Store.getOrderById(orderId); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.deleteOrder = function deleteOrder(req, res, next) { - var orderId = req.swagger.params['orderId'].value; +module.exports.deleteOrder = function deleteOrder (req, res, next) { + var orderId = req.swagger.params['orderId'].value; + + var result = Store.deleteOrder(orderId); - var result = Store.deleteOrder(orderId); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; diff --git a/samples/server/petstore/nodejs/controllers/StoreService.js b/samples/server/petstore/nodejs/controllers/StoreService.js index b4c820a034d..ba9ffd4fc44 100644 --- a/samples/server/petstore/nodejs/controllers/StoreService.js +++ b/samples/server/petstore/nodejs/controllers/StoreService.js @@ -1,57 +1,61 @@ 'use strict'; -exports.getInventory = function () { +exports.getInventory = function() { - var examples = {}; - - examples['application/json'] = { - "key": 123 - }; - - - if (Object.keys(examples).length > 0) - return examples[Object.keys(examples)[0]]; + var examples = {}; + + examples['application/json'] = { + "key" : 123 +}; + + + if(Object.keys(examples).length > 0) + return examples[Object.keys(examples)[0]]; + } -exports.placeOrder = function (body) { +exports.placeOrder = function(body) { - var examples = {}; - - examples['application/json'] = { - "id": 123456789, - "petId": 123456789, - "complete": true, - "status": "aeiou", - "quantity": 123, - "shipDate": "2015-03-19T21:51:51.599+0000" - }; - - - if (Object.keys(examples).length > 0) - return examples[Object.keys(examples)[0]]; + var examples = {}; + + examples['application/json'] = { + "id" : 123456789, + "petId" : 123456789, + "complete" : true, + "status" : "aeiou", + "quantity" : 123, + "shipDate" : "2015-07-09T06:03:19.571+0000" +}; + + + if(Object.keys(examples).length > 0) + return examples[Object.keys(examples)[0]]; + } -exports.getOrderById = function (orderId) { +exports.getOrderById = function(orderId) { - var examples = {}; - - examples['application/json'] = { - "id": 123456789, - "petId": 123456789, - "complete": true, - "status": "aeiou", - "quantity": 123, - "shipDate": "2015-03-19T21:51:51.603+0000" - }; - - - if (Object.keys(examples).length > 0) - return examples[Object.keys(examples)[0]]; + var examples = {}; + + examples['application/json'] = { + "id" : 123456789, + "petId" : 123456789, + "complete" : true, + "status" : "aeiou", + "quantity" : 123, + "shipDate" : "2015-07-09T06:03:19.576+0000" +}; + + + if(Object.keys(examples).length > 0) + return examples[Object.keys(examples)[0]]; + } -exports.deleteOrder = function (orderId) { - - var examples = {}; +exports.deleteOrder = function(orderId) { + var examples = {}; + + } diff --git a/samples/server/petstore/nodejs/controllers/User.js b/samples/server/petstore/nodejs/controllers/User.js index 89bb5368b25..d89f34c9c3f 100644 --- a/samples/server/petstore/nodejs/controllers/User.js +++ b/samples/server/petstore/nodejs/controllers/User.js @@ -6,115 +6,115 @@ var url = require('url'); var User = require('./UserService'); -module.exports.createUser = function createUser(req, res, next) { - var body = req.swagger.params['body'].value; +module.exports.createUser = function createUser (req, res, next) { + var body = req.swagger.params['body'].value; + + var result = User.createUser(body); - var result = User.createUser(body); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.createUsersWithArrayInput = function createUsersWithArrayInput(req, res, next) { - var body = req.swagger.params['body'].value; +module.exports.createUsersWithArrayInput = function createUsersWithArrayInput (req, res, next) { + var body = req.swagger.params['body'].value; + + var result = User.createUsersWithArrayInput(body); - var result = User.createUsersWithArrayInput(body); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.createUsersWithListInput = function createUsersWithListInput(req, res, next) { - var body = req.swagger.params['body'].value; +module.exports.createUsersWithListInput = function createUsersWithListInput (req, res, next) { + var body = req.swagger.params['body'].value; + + var result = User.createUsersWithListInput(body); - var result = User.createUsersWithListInput(body); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.loginUser = function loginUser(req, res, next) { - var username = req.swagger.params['username'].value; - var password = req.swagger.params['password'].value; +module.exports.loginUser = function loginUser (req, res, next) { + var username = req.swagger.params['username'].value; + var password = req.swagger.params['password'].value; + + var result = User.loginUser(username, password); - var result = User.loginUser(username, password); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.logoutUser = function logoutUser(req, res, next) { +module.exports.logoutUser = function logoutUser (req, res, next) { + + var result = User.logoutUser(); - var result = User.logoutUser(); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.getUserByName = function getUserByName(req, res, next) { - var username = req.swagger.params['username'].value; +module.exports.getUserByName = function getUserByName (req, res, next) { + var username = req.swagger.params['username'].value; + + var result = User.getUserByName(username); - var result = User.getUserByName(username); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.updateUser = function updateUser(req, res, next) { - var username = req.swagger.params['username'].value; - var body = req.swagger.params['body'].value; +module.exports.updateUser = function updateUser (req, res, next) { + var username = req.swagger.params['username'].value; + var body = req.swagger.params['body'].value; + + var result = User.updateUser(username, body); - var result = User.updateUser(username, body); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; -module.exports.deleteUser = function deleteUser(req, res, next) { - var username = req.swagger.params['username'].value; +module.exports.deleteUser = function deleteUser (req, res, next) { + var username = req.swagger.params['username'].value; + + var result = User.deleteUser(username); - var result = User.deleteUser(username); - - if (typeof result !== 'undefined') { - res.setHeader('Content-Type', 'application/json'); - res.end(JSON.stringify(result || {}, null, 2)); - } - else - res.end(); + if(typeof result !== 'undefined') { + res.setHeader('Content-Type', 'application/json'); + res.end(JSON.stringify(result || {}, null, 2)); + } + else + res.end(); }; diff --git a/samples/server/petstore/nodejs/controllers/UserService.js b/samples/server/petstore/nodejs/controllers/UserService.js index a0c37b374d3..30aab42ada9 100644 --- a/samples/server/petstore/nodejs/controllers/UserService.js +++ b/samples/server/petstore/nodejs/controllers/UserService.js @@ -1,69 +1,77 @@ 'use strict'; -exports.createUser = function (body) { - - var examples = {}; +exports.createUser = function(body) { + var examples = {}; + + } -exports.createUsersWithArrayInput = function (body) { - - var examples = {}; +exports.createUsersWithArrayInput = function(body) { + var examples = {}; + + } -exports.createUsersWithListInput = function (body) { - - var examples = {}; +exports.createUsersWithListInput = function(body) { + var examples = {}; + + } -exports.loginUser = function (username, password) { +exports.loginUser = function(username, password) { - var examples = {}; - - examples['application/json'] = "aeiou"; - - - if (Object.keys(examples).length > 0) - return examples[Object.keys(examples)[0]]; + var examples = {}; + + examples['application/json'] = "aeiou"; + + + if(Object.keys(examples).length > 0) + return examples[Object.keys(examples)[0]]; + } -exports.logoutUser = function () { - - var examples = {}; +exports.logoutUser = function() { + var examples = {}; + + } -exports.getUserByName = function (username) { +exports.getUserByName = function(username) { - var examples = {}; - - examples['application/json'] = { - "id": 123456789, - "lastName": "aeiou", - "phone": "aeiou", - "username": "aeiou", - "email": "aeiou", - "userStatus": 123, - "firstName": "aeiou", - "password": "aeiou" - }; - - - if (Object.keys(examples).length > 0) - return examples[Object.keys(examples)[0]]; + var examples = {}; + + examples['application/json'] = { + "id" : 1, + "username" : "johnp", + "firstName" : "John", + "lastName" : "Public", + "email" : "johnp@swagger.io", + "password" : "-secret-", + "phone" : "0123456789", + "userStatus" : 0 +}; + + + if(Object.keys(examples).length > 0) + return examples[Object.keys(examples)[0]]; + } -exports.updateUser = function (username, body) { - - var examples = {}; +exports.updateUser = function(username, body) { + var examples = {}; + + } -exports.deleteUser = function (username) { - - var examples = {}; +exports.deleteUser = function(username) { + var examples = {}; + + } diff --git a/samples/server/petstore/nodejs/index.js b/samples/server/petstore/nodejs/index.js index fe9724d4b88..c73b630ed20 100644 --- a/samples/server/petstore/nodejs/index.js +++ b/samples/server/petstore/nodejs/index.js @@ -8,9 +8,9 @@ var serverPort = 8080; // swaggerRouter configuration var options = { - swaggerUi: '/swagger.json', - controllers: './controllers', - useStubs: process.env.NODE_ENV === 'development' ? true : false // Conditionally turn on stubs (mock mode) + swaggerUi: '/swagger.json', + controllers: './controllers', + useStubs: process.env.NODE_ENV === 'development' ? true : false // Conditionally turn on stubs (mock mode) }; // The Swagger document (require it, build it programmatically, fetch it from a URL, ...) @@ -18,21 +18,21 @@ var swaggerDoc = require('./api/swagger.json'); // Initialize the Swagger middleware swaggerTools.initializeMiddleware(swaggerDoc, function (middleware) { - // Interpret Swagger resources and attach metadata to request - must be first in swagger-tools middleware chain - app.use(middleware.swaggerMetadata()); + // Interpret Swagger resources and attach metadata to request - must be first in swagger-tools middleware chain + app.use(middleware.swaggerMetadata()); - // Validate Swagger requests - app.use(middleware.swaggerValidator()); + // Validate Swagger requests + app.use(middleware.swaggerValidator()); - // Route validated requests to appropriate controller - app.use(middleware.swaggerRouter(options)); + // Route validated requests to appropriate controller + app.use(middleware.swaggerRouter(options)); - // Serve the Swagger documents and Swagger UI - app.use(middleware.swaggerUi()); + // Serve the Swagger documents and Swagger UI + app.use(middleware.swaggerUi()); - // Start the server - http.createServer(app).listen(8080, function () { - console.log('Your server is listening on port %d (http://localhost:%d)', 8080, 8080); - console.log('Swagger-ui is available on http://localhost:%d/docs', 8080); - }); + // Start the server + http.createServer(app).listen(8080, function () { + console.log('Your server is listening on port %d (http://localhost:%d)', 8080, 8080); + console.log('Swagger-ui is available on http://localhost:%d/docs', 8080); + }); }); \ No newline at end of file diff --git a/samples/server/petstore/nodejs/package.json b/samples/server/petstore/nodejs/package.json index 4d0356c8e60..7bb6df08fb5 100644 --- a/samples/server/petstore/nodejs/package.json +++ b/samples/server/petstore/nodejs/package.json @@ -1,7 +1,7 @@ { "name": "", - "version": "", - "description": "This is a sample server Petstore server. You can find out more about Swagger at <a href="http://swagger.io">http://swagger.io</a> or on irc.freenode.net, #swagger. For this sample, you can use the api key "special-key" to test the authorization filters", + "version": "1.0.0", + "description": "This is a sample server Petstore server. You can find out more about Swagger at <a href=\"http://swagger.io\">http://swagger.io</a> or on irc.freenode.net, #swagger. For this sample, you can use the api key \"special-key\" to test the authorization filters", "main": "index.js", "keywords": [ "swagger"