swagger-api / swagger-api/validator-badge

Cannot run validator with localhost, please help!

Open
#201 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
227
Forks
81
Avg merge
2h 3m
Merged PRs (30d)
1

Description

Hello,
I need to run Swagger validator for a localhost, ex: url = http://localhost:8085. And I searched the way to do and follow: https://stackoverflow.com/questions/32188386/cant-read-from-file-issue-in-swagger-ui and tried solution 3: Host the validator locally.

For: You will also need to tell swaggerui the location of the validator, where can I find: config.EnableSwagger().EnableSwaggerUi(c => c.SetValidatorUrl(<validator_url>));? I updated my index.html (in my project) with:

window.swaggerUi = new SwaggerUi({
//url: "/um-api/swagger.json",
url: parseUrl(),
validatorUrl: "http://localhost:8080/validator", // added this line and seems it works
dom_id: "swagger-ui-container",

I can run http://localhost:8080/validator/debug?url={site publicly accessible}/apiDocs , it works well.

But when I change to: http://localhost:8080/validator/debug?url=http://localhost:8085/apiDocs, it always return: {"schemaValidationMessages":[{"level":"error","message":"Can't read from file http://localhost:8085/apiDocs"}]}

I see some note that online swagger ui will not work with locahost but is there anyway to fix this? I really need to run the validator with url = http://localhost:8085.

Many thanks!

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

Start with the referenced index.html SwaggerUi configuration and the /validator/debug endpoint. Reproduce validation with the public URL and with http://localhost:8085/apiDocs, then trace whether the validator can reach localhost. Done means establishing a supported fix or documenting the limitation and its cause.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, testing
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.