Add Swagger like UI to view and call APIs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
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:
- 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.
- 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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the prior work in issue 5794, then inspect how endpoint annotations and the JSF and SPA user-guide links are currently organized. Done means a Swagger-like interface can view and call APIs for the relevant version and server, with useful endpoint, parameter, and response-code descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100