You will need JDK of version 7 or higher as instructed here If you'd like to rebuild the /dist folder with your codebase changes, run npm run build. If you'd like to make modifications to the codebase, run the dev server with: npm run dev. If you just want to see your specs, open dist/index.html in your browser directly from your filesystem. You can pull a pre-built docker image of the swagger-ui directly from Dockerhub:ĭocker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui Compatibility between swagger-ui and the OpenAPI Specification is as follows: Swagger UI Version The OpenAPI Specification has undergone 5 revisions since initial creation in 2010. swagger-ui-dist is a dependency-free module that includes everything you need to serve Swagger-UI in a server-side project, or a web project that can't resolve npm module dependencies.įor the older version of swagger-ui, refer to the 2.x branch.swagger-ui is a traditional npm module intended for use in JavaScript web application projects that are capable of resolving dependencies (via Webpack, Browserify, etc).This repository publishes to two different NPM modules: Check out the Known Issues section for more details. ?? Want to score an easy open-source contribution? Check out our Good first issue label.Īs a brand new version, written from the ground up, there are some known issues and unimplemented features. This is the new version of swagger-ui, 3.x.