api-elements
Advanced tools
Readme
This library provides an interface to API Elements in JavaScript.
$ npm install api-elements
const apiElements = require('api-elements');
const namespace = new apiElements.Namespace();
// Parsing a JSON Representation of API Elements tree
const parseResult = namespace.serialiser.deserialise({
element: 'parseResult',
content: []
});
console.log(parseResult);
// Creating API Elements directly
const parseResult = new namespace.elements.ParseResult();
console.log(parseResult);
An element that holds information about the result of parsing an input.
Get an array element of all child elements with the element name annotation. This property is read-only.
let annotations = parseResult.annotations;
Get the first child element with an element name of category and a class name of api. This property is read-only.
let api = parseResult.api;
Get an array element of all child elements with the element name annotation and class name error. This property is read-only.
let errors = parseResult.errors;
Get an array element of all child elements with the element name annotation and class name warning. This property is read-only.
let warnings = parseResult.warnings;
An element that annotates the input or parse result with additional information, such as warnings or errors. The content of the annotation contains the text:
console.log(`Warning: ${annotation.toValue()}`);
An optional warning, error, or other numerical code. This is a shortcut for accessing the element's code attribute.
// Show the code
console.log(annotation.code.toValue());
// Set the code
annotation.code = 123;
An element which maps a component of the parse result to the input via a given list of file locations and lengths.
The content of the source map is an array of locations.
You can use a convenience property to retrieve the sourceMap from any element.
// Print [[1, 2]]
console.log(element.sourceMapValue);
A grouping element to hold other elements.
Get an array element of all child elements with the element name copy. This property is read-only.
let copy = category.copy;
Get an array element of all child elements with the element name category and a class name dataStructures. This property is read-only.
let dataStructures = category.dataStructures;
Get an array element of all child elements with the element name resource. This property is read-only.
let resources = category.resources;
Get an array element of all child elements with the element name category and a class name resourceGroup. This property is read-only.
let groups = category.resourceGroups;
Get an array element of all child elements with a class name scenario. This property is read-only.
let scenarios = category.scenarios;
Get an array element of all child elements with the element name transition. This property is read-only.
let transitions = category.transitions;
Get an array element of all child elements with the element name category and a class name transitions. This property is read-only.
let groups = category.transitionGroups;
Get an array element of all child element with element name equal to one of the names given below. This property is read-only.
let schemes = category.authSchemes;
Get an array element of all child elements with the element name category and a class name authSchemes. This property is read-only.
let groups = category.authSchemeGroups;
An element that contains copy text used to describe elements in the API Description namespace. The element's content contains the text:
console.log(`Description: ${copy.toValue()}`);
The optional content-type of the element's content.
// Get the content-type
console.log(copy.contentType.toValue());
// Set the content-type
copy.contentType = 'text/markdown';
This element describes an auth scheme.
Get an array element of all child elements with the element name copy. This property is read-only.
let copy = scheme.copy;
Get an array element of all child elements with the element name transition. This property is read-only.
for (const transition of scheme.transitions) {
console.log(`Transition: ${transition.title}`);
}
Get an array element of all child elements with the element name member. This property is read-only.
for (const member of scheme.members) {
console.log(`Member: ${member.key}`)
}
This element describes a data structure.
Get an array element of all child elements with the element name copy. This property is read-only.
let copy = resource.copy;
The URL template of this resource.
// Get the href
console.log(`URL: ${resource.href.toValue()}`);
// Set the href
resource.href = '/foo/{id}';
The description of any variables present in the resource.href URL template.
// Get the href variables
console.log(resource.hrefVariables.keys());
// Set the href variables
resource.hrefVariables = {
id: 'foo'
}
Get an array element of all child elements with the element name transition. This property is read-only.
for (const transition of resource.transitions) {
console.log(`Transition: ${transition.title.toValue()}`);
}
Get the first child element with the element name dataStructure. This property is read-only.
console.log(resource.dataStructure.keys());
This element represents a resource transition.
Get an array element of all child elements with the element name copy. This property is read-only.
let copy = transition.copy;
Get the HTTP method of the transition, if there is one, by finding the first HTTP request and inspecting its method. This property is read-only.
let method = transition.method.toValue();
Defines a relationship to another resource or transition. Useful for hypermedia.
// Get the relation
console.log(`Relation: ${transition.relation.toValue()}`);
// Set the relation
transition.relation = '...';
Overrides the resources URL template with one specific to this transition.
// Get the href
console.log(`URL: ${transition.href.toValue()}`);
// Set the href
transition.href = '/foo/{id}';
Gets either the transition's href or the first transaction's request's href if it exists, otherwise returns null. This property is read-only.
console.log(`URL: ${transition.computedHref.toValue()}`);
The description of any variables present in the transition.href URL template.
// Get the href variables
console.log(transition.hrefVariables.keys());
// Set the href variables
transition.hrefVariables = {
id: 'foo'
}
The data structure describing the body payload for this transition.
// Get the data attributes
console.log(transition.data.toRefract());
// Set the data attributes
transition.data = minim.toElement({one: 1});
A list of content types supported by the transition.
// Get the content types
console.log(transition.contentTypes);
// Set the content types
transition.contentTypes = [
'application/json',
'application/yaml'
]
An array element of HTTP transaction elements. This property is read-only.
// Print out each transaction's HTTP request method
for (const transaction of transition.transactions) {
console.log(`${transaction.request.method}`);
}
This element represents an HTTP transaction.
The HTTP request component of this transaction. It returns an HttpRequest element if one has been defined. This property is read-only.
// Get the HTTP request
let request = transaction.request;
The HTTP response component of this transaction. It returns an HttpResponse element if one has been defined. This property is read-only.
// Get the HTTP response
let response = transaction.response;
It returns an array of elements derived from AuthScheme elements. This property is read-only.
let schemes = transaction.authSchemes;
This element represents an HTTP request.
Get an array element of all child elements with the element name copy. This property is read-only.
let copy = request.copy;
The HTTP method of this request, e.g. GET or POST.
// Get the HTTP method
console.log(`HTTP method: ${request.method.toValue()}`);
// Set the HTTP method
request.method = 'PUT';
Overrides the resources URL template with one specific to this request.
// Get the href
console.log(`URL: ${request.href.toValue()}`);
// Set the href
request.href = '/foo/{id}';
The HTTP headers for this request. See also the request.header(name) shortcut, which will get the values for a header by name.
// Get the headers element
let headers = request.headers;
// Set the headers element
request.headers = new HttpHeaders();
The computed content type of this request, either from a Content-Type header or from the message content. This property is read-only.
// Get the content type
console.log(`${request.contentType}`);
The request body data structure, if it exists. This property is read-only.
let data = request.dataStructure;
The request body content, if it exists. This property is read-only.
// Print out the body content as a string
console.log(`Body: ${request.messageBody}`);
The request body schema, if it exists. This property is read-only.
// Print out the body schema as a string
console.log(`Schema: ${request.messageBodySchema}`);
Get a case-insensitive header by name. This returns a list of strings, because headers can be defined multiple times.
// Get the content type header
let type = request.header('Content-Type')[0].toValue();
This element represents an HTTP response.
Get an array element of all child elements with the element name copy. This property is read-only.
let copy = response.copy;
The HTTP status code, e.g. 200 or 404.
// Get the status code
console.log(`Code: ${response.statusCode.toValue()}`);
// Set the status code
response.statusCode = 400;
The HTTP headers for this response. See also the response.header(name) shortcut, which will get the values for a header by name.
// Get the headers element
let headers = response.headers;
// Set the headers element
response.headers = new HttpHeaders();
The computed content type of this response, either from a Content-Type header or from the message content. This property is read-only.
// Get the content type
console.log(`${response.contentType.toValue()}`);
The response body data structure, if it exists. This property is read-only.
let data = response.dataStructure;
The response body content, if it exists. This property is read-only.
// Print out the body content as a string
console.log(`Body: ${response.messageBody}`);
The response body schema, if it exists. This property is read-only.
// Print out the body schema as a string
console.log(`Schema: ${response.messageBodySchema}`);
Get a case-insensitive header by name. This returns a list of strings, because headers can be defined multiple times.
// Get the content type header
let type = response.header('Content-Type')[0];
This element represents an HTTP message payload or schema asset.
The content type of this asset, e.g. application/json.
// Get the content type
console.log(`Type: ${asset.contentType.toValue()}`);
// Set the content type
asset.contentType = 'application/yaml';
A link to this asset.
// Get the link
console.log(`Location: ${asset.href.toValue()}`);
// Set the link
asset.href = '/path/to/asset'
This element represents a set of URI template variables.
This element represents a set of HTTP headers.
Return a filtered array element of headers with the given case-insensitive name. Each header is a member element where the key is the header name and the value is the header value.
let accept = headers.include('Accept');
Return a filtered array element of headers without the given case-insensitive name. Each header is a member element where the key is the header name and the value is the header value.
let filtered = headers.exclude('Content-Type');
This element represents the API Elements extensions element.
Gets the extension elements profile href. This property is read-only.
let profile = extension.profile.toValue();
FAQs
API Elements JavaScript
The npm package api-elements receives a total of 5,582 weekly downloads. As such, api-elements popularity was classified as popular.
We found that api-elements demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.