alikazemkhanloo/swagger-sidebar

a simple sidebar to easily navigate through endpoints

swagger-sidebar

A simple sidebar to easily navigate through endpoints.

Usage

just add this script:

...
<script src="https://cdn.jsdelivr.net/npm/swagger-sidebar/lib/bundle.js"></script>
<script>
  const reactroot = document.querySelector("#swagger-ui");
  const container = document.querySelector("body");
  initSidebar(container, reactroot);
</script>
...

• reactroot is the div element containing whole swagger app. this library will add the sidebar before this element inside container. reactroot should be the direct child of container.

How it works

it waits for the loading component to disappear and then uses querySelector to find the sections on the page. Then it renders a simple sidebar.

swagger-sidebar's Issues

Using it with L5-Swagger, sidebar is empty.

Hello I added all the necessary tags, but the sidebar doesn't show any of the endpoints.

Integrating with "swagger-ui-express"

Hi,

I'm trying to integrate the sidebar in the "swagger-ui-express" npm package (version 4.5.0).
The js is loaded correctly, there are no errors but the sidebar is blank, there is no content.

Is this project still used and/or maintained?