Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 2.98 KB

README.md

File metadata and controls

48 lines (29 loc) · 2.98 KB
Raw

API Extension Architecture (API-X)

Build Status Maven Central

API-X is a framework for binding services to repository objects in order to extend the functionality of a Fedora 4 repository. It provides a data model for expressing how services bind to repository resources, registries that support service discovery, and an HTTP middleware layer that exposes services as endpoints or mediates access to the repository transparently via these services.

For more information, please see the technical overview or try out a docker based demo that highlights what API-X is and does by providing step-by-step evaluation tasks.

Building

To build API-X, do:

mvn clean install

OSGi deployment (Karaf 4.x)

API-X is distributed as OSGi bundles and provides Karaf feature descriptors, making it easy to deploy in a Karaf container. There are several ways to install these features, please refer to the karaf provisioning documentation for more information.

Manual installation in Karaf

To do this, first, add the fcrepo-api-x-karaf repository in the Karaf console:

$ feature:repo-add mvn:org.fcrepo.apix/fcrepo-api-x-karaf/LATEST/xml/features

Then, run

$ feature:install fcrepo-api-x

This will start an instance of API-X running on default settings. API-X will presume there is a Fedora instance at http://localhost:8080/fcrepo/rest. See individual module documentation for how to override the defaults.

Contributing

Contributors to DuraSpace projects should complete a Contributor License Agreement or be covered by a corporate agreement.

License

Apache 2.0

Sponsorship

This work was made possible in part by IMLS grant LG-70-16-0076-16 Fedora 4 API Extension (API-X) Architecture, lead by Principal Investigator Sayeed Choudhury.

Design or development efforts attributed to:

  • Elliot Metsger - Johns Hopkins, Software Engineer, API-X stakeholder and developer
  • Ruth Duerr - Ronin Institute for Independent Scholarship, API-X stakeholder, Data Manager/Informaticist, ex-operations manager, ex-archive manager, ex-systems engineer, ex-software engineer & developer
  • Joshua Westgard - University of Maryland Libraries, API-X stakeholder, repository application manager
  • Aaron Birkland - Johns Hopkins, Software Engineer, API-X developer
  • Aaron Coburn and Bethany Seeger - Amherst College, API-X stakeholder and developers of the Amherst extensions used throughout the demo