swagger-api / swagger-api/validator-badge
Allow POSTing of swagger definition to validator
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 227
- Forks
- 81
- Avg merge
- 2h 3m
- Merged PRs (30d)
- 1
Description
I'm developing an API thats internal use only, and placing swagger-ui under a /swagger endpoint (so its self contained and run-able). I've just discovered swagger-ui is posting my swagger definition url out to swagger.io. This url will never be reachable by the swagger validator.
Could it be flipped?. Can the UI post the swagger.yaml to the validator?. That way there is only the requirement of the browser being able to access the validator.
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 tracing how the swagger-ui endpoint sends the definition URL to the validator and where the validator request is assembled. Check the repository's existing request handling and validation tests, then verify that a locally served swagger.yaml can be submitted when the remote URL is unreachable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100