Overview
To accompany the first evaluation release of the API-X framework, we are assembling an easy-to-use demo for stakeholders and other community members to evaluate API-X in its current state, and inform priorities and direction of future development. This first demo will:
- Use docker compose and/or Vagrant to run Fedora, API-X, a set of extensions, and a triple store
Index service discovery information in the triple store
Automatically initialize and deploy as extensions a subset of Amherst repository extension service
Include Demo objects that can be acted upon by preinstalled services
Include a guide for stakeholders, providing a number of concrete evaluation tasks to choose from and associated instructions.
Roles
Evaluation Guide
This is an outline of a guide for evaluating the API-X demo:
- Start/run demo
Verify that all demo services are running
Look at a pre-installed Fedora object behind the API-X intercepting proxy
Look at a service document for a pre-installed fedora object
Interact with an exposed service on one of the pre-installed in browser
Install an Amherst service
Deploy an extension to expose the Amherst service
Ingest an object and verify the new service works on it
Compare service documents from objects that bind to different services
Look/execute some sparql queries
Find all objects that expose a particular service
Find all endpoints (exposed by api-x) on objects that implement a particular service
List all resource-scoped service endpoints for a particular object, and identify services they implement
Look at code snippets that try to invoke a specific service on an object
When given the URI for a repository object, discover the URI for the service endpoint of the service and invoke it
