Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #2177 Providing own definition file to Docker container via SWAGGER_FILE #2181

Merged
merged 2 commits into from
Jun 23, 2020
Merged

Conversation

eugene-khyst
Copy link
Contributor

@eugene-khyst eugene-khyst commented Jun 17, 2020

Motivation and Context

Fix providing own json or yaml definition file to Docker container via SWAGGER_FILE env variable.
Fixes #2177

How Has This Been Tested?

Build the Docker image

docker build -t swaggerapi/swagger-editor .

Run the Docker container without providin own json or yaml specification file

docker run --rm -p 8080:8080 swaggerapi/swagger-editor

Open http://localhost:8080 to verify that the default Pet Store Swagger specification(https://petstore.swagger.io/v2/swagger.json) is loaded.

Download custom OpenAPI 3.0 specificcation file to specs directory

mkdir specs
curl https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml --output specs/petstore.yaml

Run the Docker container, mounting specs directory and pointing SWAGGER_FILE to /specs/petstore.yaml

docker run --rm -p 8080:8080 -v $(pwd)/specs:/specs -e SWAGGER_FILE=/specs/petstore.yaml swaggerapi/swagger-editor

Open http://localhost:8080 to verify that the custom Pet Store OpenAPI 3.0 specification (/petstore.yaml) is loaded.

In the source code of the index.html make sure url: '/petstore.yaml' is present:

const editor = SwaggerEditorBundle({
    url: '/petstore.yaml',
    dom_id: '#swagger-editor',
    layout: 'StandaloneLayout',
    presets: [
        SwaggerEditorStandalonePreset
    ]
})

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@tim-lai tim-lai self-assigned this Jun 18, 2020
@tim-lai tim-lai merged commit 0a18d83 into swagger-api:master Jun 23, 2020
@tim-lai
Copy link
Contributor

tim-lai commented Jun 23, 2020

@evgeniy-khist Merged! Thanks for the contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docker commands for local swagger file not working.
3 participants