1.0.11 • Published 8 years ago
api-endpoint v1.0.11
EndPoint
EndPoint is a schema-validated waterfall.
What does an endpoint look like?
var EndPoint = require('api-endpoint'),
Joi = EndPoint.Joi;
var myEndpoint = EndPoint.create({
headers: Joi.object(), // Headers validator
payload: Joi.object(), // Payload validator
query: Joi.object(), // Query string validator
params: Joi.object(), // URL string validator
response: Joi.object(), // Response validator
validateOptions: { // optional JOI validation options
abortEarly: false,
stripUnknown: true
},
filters: [ // An array of work to perform
function findUser(data, next) {
next(err || null, data);
},
function createTask(data, next) {
next(err || null, data);
}
]
});
module.exports = endpoint;
How do I run my endpoint?
myEndpoint.run(data, function(err, data) {
console.log(err, data); // `data` is the final object scoped to the outgoing schema
})
How do I deal with errors?
Your endpoint is a waterfall. If any of your filters
error, your endpoint will run its callback function with the error you provide (data
will be null
).
1.0.11
8 years ago
1.0.10
8 years ago
1.0.9
8 years ago
1.0.8
8 years ago
1.0.7
8 years ago
1.0.6
8 years ago
1.0.5
8 years ago
1.0.4
8 years ago
1.0.3
8 years ago
1.0.2
8 years ago
1.0.1
8 years ago
1.0.0
8 years ago
0.1.5
8 years ago
0.1.4
8 years ago
0.1.3
8 years ago
0.1.2
8 years ago
0.1.1
9 years ago
0.1.0
9 years ago
0.0.3
9 years ago
0.0.2
9 years ago
0.0.1
9 years ago
0.0.0
9 years ago