You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/contacts/:
x-swagger-router-controller: contacts
.
.
.
post:
summary: Add contact
description: Creates a new named contact entry for services or organizations
operationId: addContact
The YAML file defines the route (/contacts), controller (x-swagger-router-controller: contacts), and function name (operationId: listContacts) that will be called for the POST verb.
For the contacts controller, we need to mock up a listContacts() function that takes in the parameters of the function as defined in the YAML, and responds with a JSON object that reflects those values back to the caller.
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/contact'
This can be done fixing the body of this placeholder function located in file:
function addContact(req, res) {
// variables defined in the Swagger document can be referenced using req.swagger.params.{parameter_name}
var name = req.swagger.params.name.value || 'stranger';
var hello = util.format('Hello, %s!', name);
// this sends back a JSON response which is a single string
res.json(hello);
}
To see an example solution to a similar problem to get you started, view issue #1
The text was updated successfully, but these errors were encountered:
nfloersch
changed the title
Mock up API controller function "contacts.addContact()" to handle Swagger defined route
Mock API controller function "contacts.addContact()" to handle Swagger defined route
Jan 12, 2021
nfloersch
changed the title
Mock API controller function "contacts.addContact()" to handle Swagger defined route
Mock API controller function "contacts.addContact()" to handle Swagger defined POST route
Jan 14, 2021
The contacts route in the YAML is defined here:
The YAML file defines the route (
/contacts
), controller (x-swagger-router-controller: contacts
), and function name (operationId: listContacts
) that will be called for the POST verb.hsda-cfbtv/api/swagger/swagger.yaml
Line 73 in ce6e863
For the contacts controller, we need to mock up a listContacts() function that takes in the parameters of the function as defined in the YAML, and responds with a JSON object that reflects those values back to the caller.
In the YAML the params are listed as:
This can be done fixing the body of this placeholder function located in file:
To see an example solution to a similar problem to get you started, view issue #1
The text was updated successfully, but these errors were encountered: