How to use swagger-ui - 10 common examples

it("should add a parameter - origin - to state", function() {
      // Given
      const system = SwaggerUi({plugins: [EditorSpecPlugin]})

      // When
      system.specActions.updateSpec("one: 1", "editor")

      // Then
      const res = system.specSelectors.specOrigin()
      expect(res).toEqual("editor")
    })

response => {
                console.info(response);
                let url = response.url;
                const swaggerUI = SwaggerUI({
                    dom_id: "#ui",
                    url: response.url,
                    requestInterceptor: (req) => {
                        // Only set Authorization header if the request matches the spec URL
                        if (req.url === url) {
                          req.headers.Authorization =  "Bearer " + AuthManager.getUser().getPartialToken();
                        }
                        return req;
                      },
                    presets: [
                            SwaggerUI.presets.apis,
                            disableAuthorizeAndInfoPlugin
                    ],
                    plugins: [
                        SwaggerUI.plugins.DownloadUrl
                    ]

response => {
                console.info(response);
                let url = response.url;
                const swaggerUI = SwaggerUI({
                    dom_id: "#ui",
                    url: response.url,
                    requestInterceptor: (req) => {
                        // Only set Authorization header if the request matches the spec URL
                        if (req.url === url) {
                          req.headers.Authorization =  "Bearer " + AuthManager.getUser().getPartialToken();
                        }
                        return req;
                      },
                    presets: [
                            SwaggerUI.presets.apis,
                            disableAuthorizeAndInfoPlugin
                    ],
                    plugins: [
                        SwaggerUI.plugins.DownloadUrl
                    ]
                })
            }
        ).catch(

.then((responses) => {
                const swagger = responses[0];
                const url = swagger.url;
                this.setState({ setSwagger: true });

                const swaggerUI = SwaggerUI({
                    dom_id: '#ui',
                    url: swagger.url,
                    requestInterceptor: (req) => {
                        // Only set Authorization header if the request matches the spec URL
                        if (req.url === url) {
                            req.headers.Authorization = 'Bearer ' + AuthManager.getUser().getPartialToken();
                        }
                        return req;
                    },
                    presets: [SwaggerUI.presets.apis, disableAuthorizeAndInfoPlugin],
                    plugins: [SwaggerUI.plugins.DownloadUrl],
                });
            })
            .catch((error) => {

setTimeout(() => {
      this.richPreview = new SwaggerUIBundle({
        spec: this.getFormData(),
        dom_id: '#rich-preview',
        // Disable Swagger.io online validation (AKA spyware)
        validatorUrl: null,
        presets: [
          SwaggerUIBundle.presets.apis,
          SwaggerUIStandalonePreset
        ],
        plugins: [
          SwaggerUIBundle.plugins.DownloadUrl
        ],
        layout: 'StandaloneLayout'
      });
    }, 0);
  }

setTimeout(() => {
      this.richPreview = new SwaggerUIBundle({
        spec: this.getFormData(),
        dom_id: '#rich-preview',
        // Disable Swagger.io online validation (AKA spyware)
        validatorUrl: null,
        presets: [
          SwaggerUIBundle.presets.apis,
          SwaggerUIStandalonePreset
        ],
        plugins: [
          SwaggerUIBundle.plugins.DownloadUrl
        ],
        layout: 'StandaloneLayout'
      });
    }, 0);
  }

jQuery(document).ready(function($) {
    // We actually can't prevent SwaggerUI from overwriting the set URL with one in the query string.
    // https://github.com/swagger-api/swagger-ui/issues/4332
    if (window.location.search) {
        window.location.search = "";
    }

    window.ui = SwaggerUI({
        deepLinking: true,
        dom_id: "#swagger-ui",
        layout: "DashboardLayout",
        plugins: [
            SwaggerUI.plugins.DownloadUrl,
            vanillaForums
        ],
        presets: [
            SwaggerUI.presets.apis
        ],
        requestInterceptor: function (request) {
            request.headers["x-transient-key"] = gdn.getMeta("TransientKey");
            return request;
        },
        url: gdn.url("/api/v2/open-api/v2"),
        validatorUrl: null
    });
});

const swaggerUI = SwaggerUI({
              dom_id: "#ui",
              url: swagger.url,
              requestInterceptor: (req) => {
                  // Only set Authorization header if the request matches the spec URL
                  if (req.url === url) {
                    req.headers.Authorization =  "Bearer " + AuthManager.getUser().getPartialToken();
                  }
                  return req;
                },
              presets: [
                      SwaggerUI.presets.apis,
                      disableAuthorizeAndInfoPlugin
              ],
              plugins: [
                  SwaggerUI.plugins.DownloadUrl
              ]
          })

        }).catch(
          error => {

.then((responses) => {
                const swagger = responses[0];
                const url = swagger.url;
                this.setState({ setSwagger: true });

                const swaggerUI = SwaggerUI({
                    dom_id: '#ui',
                    url: swagger.url,
                    requestInterceptor: (req) => {
                        // Only set Authorization header if the request matches the spec URL
                        if (req.url === url) {
                            req.headers.Authorization = 'Bearer ' + AuthManager.getUser().getPartialToken();
                        }
                        return req;
                    },
                    presets: [SwaggerUI.presets.apis, disableAuthorizeAndInfoPlugin],
                    plugins: [SwaggerUI.plugins.DownloadUrl],
                });
            })
            .catch((error) => {

EditorAutosuggestSnippetsPlugin,
  EditorAutosuggestKeywordsPlugin,
  EditorAutosuggestRefsPlugin,
  EditorAutosuggestOAS3KeywordsPlugin,
  PerformancePlugin,
  JumpToPathPlugin,
  SplitPaneModePlugin,
  ASTPlugin,
}

const defaults = {
  // we have the `dom_id` prop for legacy reasons
  dom_id: "#swagger-editor", // eslint-disable-line camelcase
  layout: "EditorLayout",
  presets: [
    SwaggerUI.presets.apis
  ],
  plugins: Object.values(plugins),
  components: {
    EditorLayout
  },
  showExtensions: true,
  swagger2GeneratorUrl: "https://generator.swagger.io/api/swagger.json",
  oas3GeneratorUrl: "https://generator3.swagger.io/openapi.json",
  swagger2ConverterUrl: "https://converter.swagger.io/api/convert",
}

export default function SwaggerEditor(options) {
  let mergedOptions = deepMerge(defaults, options)

  mergedOptions.presets = defaults.presets.concat(options.presets || [])
  mergedOptions.plugins = defaults.plugins.concat(options.plugins || [])