docusaurus-openapi-docs icon indicating copy to clipboard operation
docusaurus-openapi-docs copied to clipboard

Update to let users set the base URL globally

Open tjperry07 opened this issue 1 year ago • 2 comments

Is your feature request related to a problem? No

I know the base URL can be changed by clicking edit, but it's not obvious. I want to request that users can change the base URL globally or make the highlighted area a drop down. During testing, the main issue that came up was people didn't understand they could change the URL and kept asking how to change it.

Screenshot 2024-03-20 at 4 14 25 PM

Describe the solution you'd like

Ability to change the base URL at the top so it's more obvious there are more URLs available Add it to the menu.

Describe alternatives you've considered

N/A

Additional context

  • Reduce users asking about the correct URL when viewing an endpoint.

Example showing how the URL is presented at at the top of the page.

Screenshot 2024-03-20 at 4 26 41 PM

Some options for the plugin:

  • Add it as a menu item
  • Add it to the introduction
  • Make it into a dropdown on each endpoint (preferred since it takes up a lot of real-estate versus the edit for the try it now.)
  • Set it globally at the introduction (Also preferred. See image above for example).

tjperry07 avatar Mar 20 '24 20:03 tjperry07

Otherwise, great plugin. Can't wait for the Docusaurus 3 official release.

tjperry07 avatar Mar 20 '24 20:03 tjperry07

Hi @tjperry07, adding this to our roadmap. I think the idea would to essentially flip where the select menu is today from the ApiExplorer panel to the top of ApiItem.

sserrata avatar Jun 28 '24 16:06 sserrata