swagger-api / swagger-api/swagger-ui

Add a button to display Request URL and Snippets without Live Response

Open
#8,704 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Describe alternatives you've considered

A useful feature that Swagger-UI could potentially include is a button that behaves similarly to the existing "Execute" button, but instead of providing a live response from the server, it only displays the request URL and the associated code snippets.

This feature can provide significant utility for certain Swagger-UI-based API documentation users. Some users may find it more convenient to construct the request URL using the UI, including all its parameters. They can then copy this URL within their scripts or any other preferred location.

I envision this feature being implemented as a button, placed under the existing "Execute" button, and could be labeled something like "Print URL".

By implementing this feature, the flexibility and usability of Swagger-UI enable users to tailor their interaction with the API documentation to their specific needs.

Please let me know your thoughts on this feature and its potential value. Thank you.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are identified in the issue. Start by locating the existing Execute button and the code that displays request URLs and snippets; done means a separate button can show both without making a live request.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.