Uploaded image for project: 'DSpace'
  1. DSpace
  2. DS-1657

Adopt/Create an official DSpace REST API


    • Type: New Feature
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Fixed
    • Fix Version/s: 4.0
    • Component/s: None
    • Labels:
    • Attachments:
    • Comments:
    • Documentation Status:


      As has been discussed many times, DSpace needs a REST API. Based on discussions in the Developer Meeting on Sept 18, 2013 (http://irclogs.duraspace.org/index.php?date=2013-09-18 ), the DSpace Committers have come up with a loose set of requirements around what we need out of a REST API.

      Requirements for REST API inclusion:

      1. A read-only API is acceptable, as long as it respects DSpace authorization (e.g. controls access to withdrawn/restricted/embargoed/private objects)

      2. If the API supports write access, it MUST either be:
      a) Disabled by default, OR
      b) Fully support proper DSpace authentication and authorization (to ensure write access is secure)

      3. Any API must meet all current DSpace submission requirements. For example:
      a) should support both PostgreSQL and Oracle (or come with plans to support both)
      b) should follow recommendations at: https://wiki.duraspace.org/display/DSPACE/Code+Contribution+Guidelines

      Currently (as of Sept 2013), we do not have any REST API candidate solutions which meet all three of these general guidelines (though several are close). A call for submissions was put out to the community at: http://dspace.2283337.n4.nabble.com/call-for-REST-API-candidates-for-inclusion-into-DSpace-4-0-td4667378.html

      If you have an API which you'd like to contribute based on these guidelines, please create a GitHub Pull Request which references this ticket. The Committers will review any candidate submissions and decide which seems most appropriate for inclusion. Once a Pull Request has been submitted, we also may be able to find someone to work with you to better meet our guidelines for inclusion (if your initial work does not fully meet all these guidelines).


          Issue Links



              • Assignee:
                peterdietz Peter Dietz
                tdonohue Tim Donohue
              • Votes:
                1 Vote for this issue
                4 Start watching this issue


                • Created: