Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] UI: REST-API Viewer DX #196

Open
11 tasks
mountainash opened this issue Jun 27, 2024 · 1 comment
Open
11 tasks

[Feature] UI: REST-API Viewer DX #196

mountainash opened this issue Jun 27, 2024 · 1 comment

Comments

@mountainash
Copy link

mountainash commented Jun 27, 2024

The "Rest-Api Viewer" is awesome for a Developer as it's so quick and easy to see how the data from the endpoints look which helps build tool quicker to consume them.

Here's a few things that would make it even faster and easier to use:

  • BUG: at /system/api on narrow screens the "playground" button disappear (so you can't open the Viewer)
  • UI: on narrow screens the Playground viewer could expand to full-width (removing the blurred overlay to the left)
  • DX: for the {model} endpoints, it would be awesome if the "PATH PARAMETERS > model" input could use a HTML5 to prefill the value
    • HTML5 for the "locale" field
    • HTML5 for the assets/images/ "m" field
    • HTML5 for the assets/images/ "mime" field
  • DX: the tips on the assets/images/ endpoints are very helpful, it would be great if the "filter", "fields" and "populate" fields also had expected format samples aswell
  • DX: more complex field like "filter" could have a link to a Support doc to show all possible usage
  • DX: field with type "int" could change to HTML type="number" inputs
  • In addition to the "CURL" command shortcut - it would also be nice to have just the raw URL with a link to open it in a new tab and a copy to clipboard button.
  • BUG? the "FILL EXAMPLE" button doesn't seem to do anyhing 🤷🏼
Screenshot 2024-06-27 at 9 07 12 pm
@aheinze
Copy link
Collaborator

aheinze commented Jun 28, 2024

All good DX suggestions, but I'm using Rapidoc for the ui. Hard to implement improvements here 😕

Will look into the reported bugs 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants