Skip to content

installation.md

Latest commit

 

History

History
58 lines (45 loc) · 1.63 KB

installation.md

File metadata and controls

58 lines (45 loc) · 1.63 KB
Raw

Installation

Distribution channels

NPM Registry

We publish two modules to npm: swagger-client. swagger-client is meant for consumption by any JavaScript engine (node.js, web, etc...). The npm package contains transpiled and minified ES5 compatible code.

 $ npm install swagger-client

After installed successfully:

ES6 imports

import SwaggerClient from 'swagger-client'

CommonJS imports

const SwaggerClient = require('swagger-client')

unpkg

You can embed Swagger UI's code directly in your HTML by using unpkg's interface.

<html>
  <head>
    <script src="//unpkg.com/swagger-client"></script>
    <script>
      new SwaggerClient('http://petstore.swagger.io/v2/swagger.json')
        .then(
          client => client.apis.pet.addPet({ id: 1, body: { name: "bobby" } }),
          reason => console.error('failed to load the spec: ' + reason)
        )
        .then(
          addPetResult => console.log(addPetResult.body),
          reason => console.error('failed on api call: ' + reason)
        );
    </script>
  </head>
  <body>
    check console in browser's dev. tools
  </body>
</html>

See unpkg's main page for more information on how to use unpkg.

Static files without HTTP or HTML

Once swagger-ui has successfully generated the /dist and /browser directory, you can copy files from those directories to your own file system and host from there.