API Documentation

The API documentation page is automatically generated by sapi-nt, based on the application’s configured endpoints and documentation configuration.

Code examples in the documentation are rendered with syntax highlighting provided by highlight.js.

The API documentation page is comprised by the following sections:

• Side bar
• Introduction
• API Structure
• API Summary
• API Detail
• Prefix Mapping
• Data Reference

It uses the following common style classes:

Side Bar

The side bar is automatically generated using Javascript that is embedded in the page, and displays links to each of the main sections of the page and some sub-sections.

It uses the following style classes:

Introduction

The introduction section contains an introductory narrative that is supplied by the documentation configuration. As such most of the markup, including style classes, will be determined by the author.

The introduction section uses the following style classes:

API Structure

The API structure section contains general information about the standard features and usage of sapi-nt APIs. It displays tables of the available content types and standard filter prefixes that can be used to filter results by a range of values.

The API structure section uses the following style classes:

Content Type Table

The content type table has two columns. The left column displays the file extension for each content type served by the API, and the right column displays the corresponding MIME type.

The content type table uses the following style classes:

Filter Prefix Table

The filter prefix table has two columns. The left column displays the prefixes that can be applied to filter parameters. The right column displays a brief description of the prefix.

API Summary

The API summary section displays an overview of the endpoints exposed by the API, and groups together endpoints with similar functionality (this is determined by the documentation configuration). It displays a table of endpoints for each group.

It uses the following style classes:

Endpoints Table

The table of endpoints has columns for the description, URL and query parameters of each endpoint. These columns can be excluded or reordered depending on the documentation configuration.

It uses the following style classes:

API Detail

The API detail section contains more detailed information about the API endpoints, and groups together endpoints which return data about the same types of resources, known as classes (this is determined by the documentation configuration). The returned data section for each endpoint can be toggled by clicking on the “Show” and “Hide” links.

The API detail section uses the following style classes:

Property Table

The table of properties illustrates the properties that are expected to be included in the data returned by an endpoint, as well as the properties (and property paths) for which a user may apply filters or projections. It has columns for the type, cardinality, and description of each property path. It also has a column which displays a list of a views in which the property path is available for retrieval and filtering.

It uses the following style classes:

Prefix Mapping

The prefix mapping section contains a table of the namespace prefix mappings that are configured in the API’s data model. These are represented as a table.

The prefix mapping section uses the following style classes:

Prefix Table

The prefix table has two columns. The left column displays the compact form of each prefix, and the right column displays the full URI. It shares some style classes with the similar table which is rendered in the data model documentation.

The prefix table uses the following style clases:

Data Reference

The data reference section contains definitions for terms which are referenced in the documentation or the API results, such as RDF properties and concept schemes. This is based on a vocabulary file that is supplied by the documentation configuration.

The data reference section uses the following style classes: