sla-graphql-manager
v0.0.16
Published
GraphQL manager
Downloads
21
Readme
SLA Graphql manager
SLA GraphQL manager, used to manage service level agreements (SLA) for GraphQL APIs.
Instalation
npm i --save sla-graphql-manager@latest
yarn add sla-graphql-manager@latest
Importing
sla-graphql-manager can be imported by your export called instanceSLAGraphqlManager
import { instanceSLAGraphqlManager } from 'sla-graphql-manager';
Usage
Example usage:
// importing dependencies
import { instanceSLAGraphqlManager } from 'sla-graphql-manager';
import fs from 'fs';
// Configuration of the API that be introspected
const introspectionConf = {
// Url of the Graphql Server API
url: 'https://api.spacex.land/graphql',
// Authentication headers for the API
headers: {},
// Introspection query levels
levels: 4 // default: 10
};
// Initialization of SLA manager
const manager = instanceSLAGraphqlManager({ introspectionConf });
// Read the content of the SLA agreement
const slaAgremment = fs.readFileSync('my-sla-agreement.yaml', 'utf8');
// Pass as arg the SLA agreement
// This method validate the introspection API
// and validate the SLA agreement.
//
// If the validation *catch* return a *error*
// however that all be correct return a *true*
const error = await manager.registerSLA(slaAgremment);
if (error != true) {
console.error('An error occurred');
process.exit(1); // Error exit
}
console.log('Thats be ok!');
process.exit(0); // Successfully exit