Anropa externa tjänster med API() och drivrutinerna i NEWAPI()

Total.js 5 · total5@0.0.19 apiservicesintegrations Körd med Total.js 5

API(name, schema, data, [$]) anropar en operation i en extern tjänst och NEWAPI() registrerar drivrutinen som gör anropet, så att koden i dina åtgärder inte beror på hur tjänsten nås (HTTP, ett bibliotek, en kö...).

NEWAPI('name', driver) registrerar drivrutinen för tjänsten name ('a,b' registrerar en drivrutin för två namn och NEWAPI(driver) registrerar default). NEWAPI('name', config, driver) sparar också ett config-objekt som varje anrop får som options.config.
Drivrutinen är function(options, next). options.name är tjänsten, options.schema operationen, options.data datan och options.config konfigurationen. Svara med next(error, response).
API('name', 'operation', data) returnerar en builder: avsluta den med .callback($) (svaret går till åtgärden $), .callback(function(err, response) {}) eller await ....promise($). .configure({ key: value }) lägger till i options.config för det anropet och .error('text') gör att ett tomt svar misslyckas med det meddelandet.
Om ingen drivrutin är registrerad för namnet misslyckas anropet med API is not initialized.

definitions/api.js

// The driver of a fake weather service: in a real one this would be an HTTP request
NEWAPI('weather', { unit: 'C' }, function(options, next) {
	if (options.schema === 'forecast')
		next(null, { city: options.data.city, temperature: 21, unit: options.config.unit, service: options.name });
	else
		next('Unknown operation ' + options.schema);
});

controllers/weather.js

exports.install = function() {
	ROUTE('GET /forecast/', forecast);
	ROUTE('GET /forecast-fahrenheit/', fahrenheit);
	ROUTE('GET /unknown/', unknown);
	ROUTE('GET /missing/', missing);
	ROUTE('GET /promise/', promise);
};

function forecast($) {
	API('weather', 'forecast', { city: $.query.city }).callback($);
}

function fahrenheit($) {
	API('weather', 'forecast', { city: $.query.city }).configure({ unit: 'F' }).callback($);
}

function unknown($) {
	API('weather', 'rain', {}).callback($);
}

function missing($) {
	API('nobody', 'forecast', {}).callback($);
}

async function promise($) {
	const data = await API('weather', 'forecast', { city: 'Oslo' }).promise($);
	$.json({ city: data.city, same: true });
}