Resource Documentation

ISAM provides the capability for a RESTful API to be extended such that a request can be made to retrieve documentation for the API.

This is achieved through the use of a HTTP Transformation rule. The rule will look for a certain accept header value and if it exists the documentation file which was provided during the configuration of the API will be returned. For example an API Access Control resource GET /scim/groups is configured with the documentation content type set to application/swagger.json and the documentation file set as scimgroups.json. The following CURL request returns the contents of the documentation file scimgroups.json:

curl —H "Accept: application/swagger.json" k --user 
easuser:password https://isam.test.com/scim/groups

API Access Control allows the API documentation HTTP Transformation rule to be created and enabled when we are creating or modifying a resource. Set the documentation content type and file as part of the resource data.

The documentation files are served by the Web Reverse proxy local junction and are stored within the /apiac directory.

The new location can be managed using the new API Access Control management capabilities or as part of the existing Reverse Proxy management root. The directory is created when an API resource is first created and cannot be deleted. Files can be added directly to the /apiac directory or a complex sub directory structure can be created.

Parent topic: Overview of the API Access Control