swagger-api / swagger-api/swagger-ui
Add a text box to validate JSON against an Operation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
This may have come up before, but it's a really cool idea so I want to make sure it's at least logged here.
Often times we want to see if some request or response that we've seen is valid against the OpenAPI definition. Doing that by eye isn't fun, and it'd be cool if we could paste the JSON into SwaggerUI somewhere and see how valid/invalid it is.
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
The issue does not name a file, test, or entry point. Begin by locating the Swagger UI operation view and its OpenAPI validation path, then define where pasted request or response JSON is entered and how validity is reported. Done means users can paste JSON for an operation and see whether it conforms to the OpenAPI definition, with valid and invalid cases covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, openapi
- Domain
- api, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100