dataverse icon indicating copy to clipboard operation
dataverse copied to clipboard

Add Swagger like UI to view and call APIs

Open stevenwinship opened this issue 1 month ago • 0 comments

A number of people have asked for an easier way to view and use Dataverse's API's. With version 2 coming, it would be nice to have a Swagger like UI to view and call API's based on the version and the server (Prod, QA, local, etc.). The tasks that would need to be completed are:

  1. Update the annotations for each endpoint with better descriptions of the use of the API, parameters, and meaningful descriptions of response codes. Right now this information is a generically generated and not very useful.
  2. Add a link (possibly under or near the link for the user guide) in both JSF and SPA UIs.

Continue where this Issue left off https://github.com/IQSS/dataverse/issues/5794

What kind of user is the feature intended for? Admins, Developers, and API Users

**Any open or closed issues related to this feature request?**https://github.com/IQSS/dataverse/issues/5794

stevenwinship avatar Nov 20 '25 16:11 stevenwinship