Introduction
The Fedora REST API is an experimental feature that exposes a subset of the Fedora Access and Management APIs as a RESTful (Representational State Transfer) Web Service. The REST API may replace the API-A-Lite and API-M-Lite interfaces in future versions of Fedora.
As the Fedora REST API is an experimental interface, it should not be considered stable. In particular, future releases may implement a different subset of the Fedora Access and Management APIs and may employ different URL endpoints or HTTP methods. Finally, the REST API has not undergone security testing, so production repositories are cautioned against enabling the REST API without thorough evaluation.
The Documentation for the REST API delivered in the Fedora Repository 3.0 and 3.1 2 is located here.
The REST API is not complete and we are collecting critiques before finishing it. We are concerned that adding too much (all API-M functionality) into it will make it too hard to use. When Matt Zumwalt's team created the first version, they suggested that the REST API find a sweet spot between functionality and simplicity needed for developers who want to use the Web architecture. The goal is that the API would provide low barriers to entry in its use. It is identified as "experimental" because there need to be some additions and realignment of the functions. The datastream management functionality is incomplete and there is no simple way to manage relations.
This is a forum to discuss improvements to the API.
Topics
- Datastream management
- No support for disseminations (Service Endpoints) other than datastream disseminations
- Relations features