It's human-readable and machine-readable.Product managers, partners, and even potential clients can have input into the design of your API because they can see it clearly mapped out in the friendly UI. It's comprehensible for developers and non-developers.Swagger has certain benefits compared with other frameworks, such as: You can use whatever building materials you like, but you can't step outside the parameters of the blueprint. You can think of it as a blueprint for a house.
#SWAGGER EDITOR INDEX.HTML CODE#
Swagger (now known as the OpenAPI Initiative, under the structure of the Linux Foundation) is a framework for describing your API by using a common language that is easy to read and understand for developers and testers, even if they have weak source code knowledge. We will start by discussing what Swagger UI is, why it's worth using, and then move on to the tutorial.
#SWAGGER EDITOR INDEX.HTML HOW TO#
Open index.html in your HTML editor and replace "" with the URL for your OpenAPI 3.0 spec.In this article, I will show you how to use Swagger UI for API testing.Copy the contents of the /dist folder to your server.The folder /dist includes all the HTML, CSS and JS files needed to run SwaggerUI on a static website or CMS, without requiring NPM. Once swagger-ui has successfully generated the /dist directory, you can copy this to your own file system and host from there. See unpkg's main page for more information on how to use unpkg.
Using StandalonePreset will render TopBar and ValidatorBadge as well. You can embed Swagger UI's code directly in your HTML by using unpkg's interface: This will serve Swagger UI at /swagger instead of /.įor more information on controlling Swagger UI through the Docker image, see the Docker section of the Configuration documentation. The base URL of the web application can be changed by specifying the BASE_URL environment variable: docker run -p 80:8080 -e BASE_URL=/swagger -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui Or you can provide your own swagger.json on your host docker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /bar:/foo swaggerapi/swagger-ui Will start nginx with Swagger UI on port 80. You can pull a pre-built docker image of the swagger-ui directly from Docker Hub: docker pull swaggerapi/swagger-uiĭocker run -p 80:8080 swaggerapi/swagger-ui SwaggerUIBundle is equivalent to SwaggerUI. SwaggerUIBundle.SwaggerUIStandalonePreset You could do something like this: var SwaggerUIBundle = require('swagger-ui-dist').SwaggerUIBundle If you're in a JavaScript project that can't handle a traditional npm module, The module also exports SwaggerUIBundle and SwaggerUIStandalonePreset, so The folder also has an index.html asset, to make it easy to serve Swagger UI like so: const express = require('express')Ĭonst pathToSwaggerUi = require('swagger-ui-dist').absolutePath() The most useful file is swagger-ui-bundle.js, which is a build of Swagger UI that includes all the code it needs to run in one file. The module's contents mirror the dist folder you see in the Git repository. Will result in more code going across the wire. Note: we suggest using swagger-ui when your tooling makes it possible, as swagger-ui-dist The module, when imported, includes an absolutePath helper function that returns the absolute filesystem path to where the swagger-ui-dist module is installed. In contrast, swagger-ui-dist is meant for server-side projects that need assets to serve to clients. See the Webpack Getting Started sample for details. Here's an example: import SwaggerUI from 'swagger-ui' Its main file exports Swagger UI's main function, and the module also includes a namespaced stylesheet at swagger-ui/dist/swagger-ui.css. Swagger-ui is meant for consumption by JavaScript web projects that include module bundlers, such as Webpack, Browserify, and Rollup. We publish two modules to npm: swagger-ui and swagger-ui-dist.
Installation Distribution channels NPM Registry