swagger-api / swagger-api/swagger-ui
Show request snippets code example without executing request?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
It would be nice to be able to view the CURL command and the request URL for a request without actually executing the request. Especially for POST requests, this would be very useful, as you may not want to execute the actual POST. The response data is not used in either of these sections.
I've looked through the source code for the components of Execute and Curl, but I don't see any way to reasonably implement this with the plugin API. Is this possible?
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 examining the Execute and Curl components and the plugin API to determine whether request URLs and cURL snippets can be generated without sending the request. Clarify the desired behavior for POST requests and how the existing response-independent sections should work. Done means users can view both snippets without executing the request, with coverage for the relevant UI behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100