api documentation for swagger-ui-lite (2018.12.8)

this zero-dependency package will provide a rollup, single-script version of the swagger-ui client (v2.1.5), with a working web-demo

table of contents

  1. module exampleFileList
    1. string exampleFileList.0
  2. module swagger-ui-lite
    1. function swagger-ui-lite.assertThrow (passed, message)
    2. function swagger-ui-lite.functionOrNop (fnc)
    3. function swagger-ui-lite.identity (value)
    4. function swagger-ui-lite.nop ()
    5. number swagger-ui-lite.timeExit
    6. object swagger-ui-lite.local
    7. object swagger-ui-lite.swagger_ui
    8. object swagger-ui-lite.timerTimeoutAjaxProgressHide
    9. string swagger-ui-lite.__dirname
  3. module swagger_ui
    1. object swagger_ui.exports
  4. module swagger_ui.exports
    1. function swagger_ui.exports.ApiKeyAuthorization ()
    2. function swagger_ui.exports.PasswordAuthorization ()
    3. function swagger_ui.exports.SwaggerClient (url, options)
    4. function swagger_ui.exports.clientCredentialsFlow (scopes, tokenUrl, OAuthSchemeKey)
    5. function swagger_ui.exports.handleLogin ()
    6. function swagger_ui.exports.handleLogout ()
    7. function swagger_ui.exports.initOAuth (opts)
    8. function swagger_ui.exports.onOAuthComplete (token, OAuthSchemeKey)
    9. function swagger_ui.exports.processOAuthCode (data)
    10. object swagger_ui.exports.Docs
    11. object swagger_ui.exports.SwaggerUi
    12. object swagger_ui.exports.authorizations
    13. object swagger_ui.exports.window
  5. module swagger_ui.exports.Docs
    1. function swagger_ui.exports.Docs.collapseEndpointListForResource (resource)
    2. function swagger_ui.exports.Docs.collapseOperation (elem)
    3. function swagger_ui.exports.Docs.collapseOperationsForResource (resource)
    4. function swagger_ui.exports.Docs.escapeResourceName (resource)
    5. function swagger_ui.exports.Docs.expandEndpointListForResource (resource)
    6. function swagger_ui.exports.Docs.expandOperation (elem)
    7. function swagger_ui.exports.Docs.expandOperationsForResource (resource)
    8. function swagger_ui.exports.Docs.shebang ()
    9. function swagger_ui.exports.Docs.toggleEndpointListForResource (resource)
  6. module swagger_ui.exports.SwaggerClient
    1. function swagger_ui.exports.SwaggerClient (url, options)
    2. function swagger_ui.exports.SwaggerClient.ApiKeyAuthorization (name, value, type)
    3. function swagger_ui.exports.SwaggerClient.CookieAuthorization (cookie)
    4. function swagger_ui.exports.SwaggerClient.PasswordAuthorization (username, password)
    5. function swagger_ui.exports.SwaggerClient.SwaggerApi (url, options)
    6. object swagger_ui.exports.SwaggerClient.SchemaMarkup
  7. module swagger_ui.exports.SwaggerClient.ApiKeyAuthorization.prototype
    1. function swagger_ui.exports.SwaggerClient.ApiKeyAuthorization.prototype.apply (obj)
  8. module swagger_ui.exports.SwaggerClient.CookieAuthorization.prototype
    1. function swagger_ui.exports.SwaggerClient.CookieAuthorization.prototype.apply (obj)
  9. module swagger_ui.exports.SwaggerClient.PasswordAuthorization.prototype
    1. function swagger_ui.exports.SwaggerClient.PasswordAuthorization.prototype.apply (obj)
  10. module swagger_ui.exports.SwaggerClient.prototype
    1. function swagger_ui.exports.SwaggerClient.prototype.build (mock)
    2. function swagger_ui.exports.SwaggerClient.prototype.buildFromSpec (response)
    3. function swagger_ui.exports.SwaggerClient.prototype.fail (message)
    4. function swagger_ui.exports.SwaggerClient.prototype.help (dontPrint)
    5. function swagger_ui.exports.SwaggerClient.prototype.idFromOp (path, httpMethod, op)
    6. function swagger_ui.exports.SwaggerClient.prototype.initialize (url, options)
    7. function swagger_ui.exports.SwaggerClient.prototype.makeUniqueOperationId (operationId, api)
    8. function swagger_ui.exports.SwaggerClient.prototype.parseUri (uri)
    9. function swagger_ui.exports.SwaggerClient.prototype.setBasePath (basePath)
    10. function swagger_ui.exports.SwaggerClient.prototype.setHost (host)
    11. function swagger_ui.exports.SwaggerClient.prototype.setSchemes (schemes)
    12. function swagger_ui.exports.SwaggerClient.prototype.tagFromLabel (label)
  11. module swagger_ui.exports.SwaggerUi
    1. function swagger_ui.exports.SwaggerUi.buildUrl (base, url)
    2. function swagger_ui.exports.SwaggerUi.collapseAll ()
    3. function swagger_ui.exports.SwaggerUi.expandAll ()
    4. function swagger_ui.exports.SwaggerUi.getOption (option)
    5. function swagger_ui.exports.SwaggerUi.initialize (options)
    6. function swagger_ui.exports.SwaggerUi.listAll ()
    7. function swagger_ui.exports.SwaggerUi.load ()
    8. function swagger_ui.exports.SwaggerUi.onLoadFailure (data)
    9. function swagger_ui.exports.SwaggerUi.render ()
    10. function swagger_ui.exports.SwaggerUi.renderGFM ()
    11. function swagger_ui.exports.SwaggerUi.setOption (option, value)
    12. function swagger_ui.exports.SwaggerUi.showMessage (data)
    13. function swagger_ui.exports.SwaggerUi.updateSwaggerUi (data)
    14. object swagger_ui.exports.SwaggerUi.Collections
    15. object swagger_ui.exports.SwaggerUi.Models
    16. object swagger_ui.exports.SwaggerUi.Views
    17. object swagger_ui.exports.SwaggerUi.api
    18. object swagger_ui.exports.SwaggerUi.headerView
    19. object swagger_ui.exports.SwaggerUi.mainView
    20. object swagger_ui.exports.SwaggerUi.options
    21. object swagger_ui.exports.SwaggerUi.partials
    22. object swagger_ui.exports.SwaggerUi.utils
    23. string swagger_ui.exports.SwaggerUi.dom_id
  12. module swagger_ui.exports.authorizations
    1. function swagger_ui.exports.authorizations.add ()

module exampleFileList

module swagger-ui-lite

function swagger-ui-lite.assertThrow (passed, message)

function swagger-ui-lite.functionOrNop (fnc)

function swagger-ui-lite.identity (value)

function swagger-ui-lite.nop ()

module swagger_ui

module swagger_ui.exports

function swagger_ui.exports.ApiKeyAuthorization ()

function swagger_ui.exports.PasswordAuthorization ()

function swagger_ui.exports.SwaggerClient (url, options)

function swagger_ui.exports.clientCredentialsFlow (scopes, tokenUrl, OAuthSchemeKey)

function swagger_ui.exports.handleLogin ()

function swagger_ui.exports.handleLogout ()

function swagger_ui.exports.initOAuth (opts)

function swagger_ui.exports.onOAuthComplete (token, OAuthSchemeKey)

function swagger_ui.exports.processOAuthCode (data)

module swagger_ui.exports.Docs

function swagger_ui.exports.Docs.collapseEndpointListForResource (resource)

function swagger_ui.exports.Docs.collapseOperation (elem)

function swagger_ui.exports.Docs.collapseOperationsForResource (resource)

function swagger_ui.exports.Docs.escapeResourceName (resource)

function swagger_ui.exports.Docs.expandEndpointListForResource (resource)

function swagger_ui.exports.Docs.expandOperation (elem)

function swagger_ui.exports.Docs.expandOperationsForResource (resource)

function swagger_ui.exports.Docs.shebang ()

function swagger_ui.exports.Docs.toggleEndpointListForResource (resource)

module swagger_ui.exports.SwaggerClient

function swagger_ui.exports.SwaggerClient (url, options)

function swagger_ui.exports.SwaggerClient.ApiKeyAuthorization (name, value, type)

function swagger_ui.exports.SwaggerClient.CookieAuthorization (cookie)

function swagger_ui.exports.SwaggerClient.PasswordAuthorization (username, password)

function swagger_ui.exports.SwaggerClient.SwaggerApi (url, options)

module swagger_ui.exports.SwaggerClient.ApiKeyAuthorization.prototype

function swagger_ui.exports.SwaggerClient.ApiKeyAuthorization.prototype.apply (obj)

module swagger_ui.exports.SwaggerClient.CookieAuthorization.prototype

function swagger_ui.exports.SwaggerClient.CookieAuthorization.prototype.apply (obj)

module swagger_ui.exports.SwaggerClient.PasswordAuthorization.prototype

function swagger_ui.exports.SwaggerClient.PasswordAuthorization.prototype.apply (obj)

module swagger_ui.exports.SwaggerClient.prototype

function swagger_ui.exports.SwaggerClient.prototype.build (mock)

function swagger_ui.exports.SwaggerClient.prototype.buildFromSpec (response)

function swagger_ui.exports.SwaggerClient.prototype.fail (message)

function swagger_ui.exports.SwaggerClient.prototype.help (dontPrint)

function swagger_ui.exports.SwaggerClient.prototype.idFromOp (path, httpMethod, op)

function swagger_ui.exports.SwaggerClient.prototype.initialize (url, options)

function swagger_ui.exports.SwaggerClient.prototype.makeUniqueOperationId (operationId, api)

function swagger_ui.exports.SwaggerClient.prototype.parseUri (uri)

function swagger_ui.exports.SwaggerClient.prototype.setBasePath (basePath)

function swagger_ui.exports.SwaggerClient.prototype.setHost (host)

function swagger_ui.exports.SwaggerClient.prototype.setSchemes (schemes)

function swagger_ui.exports.SwaggerClient.prototype.tagFromLabel (label)

module swagger_ui.exports.SwaggerUi

function swagger_ui.exports.SwaggerUi.buildUrl (base, url)

function swagger_ui.exports.SwaggerUi.collapseAll ()

function swagger_ui.exports.SwaggerUi.expandAll ()

function swagger_ui.exports.SwaggerUi.getOption (option)

function swagger_ui.exports.SwaggerUi.initialize (options)

function swagger_ui.exports.SwaggerUi.listAll ()

function swagger_ui.exports.SwaggerUi.load ()

function swagger_ui.exports.SwaggerUi.onLoadFailure (data)

function swagger_ui.exports.SwaggerUi.render ()

function swagger_ui.exports.SwaggerUi.renderGFM ()

function swagger_ui.exports.SwaggerUi.setOption (option, value)

function swagger_ui.exports.SwaggerUi.showMessage (data)

function swagger_ui.exports.SwaggerUi.updateSwaggerUi (data)

module swagger_ui.exports.authorizations

function swagger_ui.exports.authorizations.add ()

[ this document was created with utility2 ]