reference to an external file is unsupported

Q&A (please complete the following information)

• OS: not relevant
• Browser: not relevant
• Version: I don’t understand…
• Method of installation: docker
• Swagger-UI version: 3.25.0
• Swagger/OpenAPI version: not relevant

Content & configuration

Example Swagger/OpenAPI definition found at https://swagger.io/docs/specification/using-ref/#allowed-places :

    paths:
      /users:
        $ref: '../resources/users.yaml'
      /users/{userId}:
        $ref: '../resources/users-by-id.yaml'

Describe the bug you’re encountering

References to external files seem to be unsupported

To reproduce…

Steps to reproduce the behavior:

1. Open the your inspector with F12
2. You should see one 404 per external file you reference
3. You will also see errors in SwaggerUI

Expected behavior

Status code 200, no errors

Additional context or thoughts

This is because only the main file is linked to the document root:

https://github.com/swagger-api/swagger-ui/blob/ba953aaa9175470fe9412b00b0ba6a8a74f78e08/docker/run.sh#L32-L33

Any file that is referenced is not copied to the document root. I worked around the bug by overriding the Docker command so that it does that copy before running the main process.

[waterkip]

@webron I have a PR that fixes this issue, been open since August 2019. https://github.com/swagger-api/swagger-ui/pull/5565

With that fix you could use volume mounts to address the problem as described in https://github.com/swagger-api/swagger-ui/issues/5966#issuecomment-615654058 like so:

docker run -p 80:8080 --rm -v $(pwd)/openapi:/opt/foo \
   -v $(pwd)/../spec.json:/opt/foo/bar \
   -e SWAGGER_JSON=/opt/foo/bar/spec.json swagger-api/swagger-ui

[tim-lai]

PR #5565 was accepted and merged awhile back. Closing issue.