nestjs-stoplight-elements v0.1.6

NestJS Module for Stoplight Elements OpenAPI

Stoplight Elements Interactive API Docs for your NestJS app. Inspired by NestJS-Redoc

It's almost a drop in replacement for you current swagger UI, you only need to import this package and modify any settings you may want to change

Installation

npm i nestjs-stoplight-elements

How to use

You need to install the Swagger Module first if you want to get definitions updated with your project.

In future versions you will be able to pass a URL parameter as document, but for the moment you need this document object from the swagger module

const options = new DocumentBuilder()
  .setTitle('Look, i have a title')
  .setDescription('A very nice description')
  .setBasePath('/api/v1')
  .build();
const document = SwaggerModule.createDocument(app, options);

Then add the following example code.

Note: All properties are optional, if you don't specify a title we will fallback to the one you used in your DocumentBuilder instance.

// Instead of using SwaggerModule.setup() you call this module
const options = {
  layout: 'sidebar',
  // see available options below
};

const StoplightElements = new StoplightElementsModule(app, document, options);
await StoplightElements.start('/docs');

Available options

From Stoplight Elements Docs

• basePath - Helps when using router: 'history' but docs are in a subdirectory like https://example.com/docs/api.
• hideInternal - Pass "true" to filter out any content which has been marked as internal with x-internal.
• hideTryIt - Pass true to hide the "Try It" panel (the interactive API console).
• tryItCorsProxy - Pass the URL of a CORS proxy used to send requests to TryIt. The provided url is prepended to the URL of an actual request.
• layout - There are two layouts for Elements:
  • sidebar - (default) Three-column design.
  • stacked - Everything in a single column, making integrations with existing websites that have their own sidebar or other columns already.
• logo - URL to an image that will show as a small square logo next to the title, above the table of contents.
• router - Determines how navigation should work:
  • history - (default) uses the HTML5 history API to keep the UI in sync with the URL.
  • hash - uses the hash portion of the URL (i.e. window.location.hash) to keep the UI in sync with the URL.
  • memory - keeps the history of your "URL" in memory (does not read or write to the address bar).
  • static - renders using the StaticRouter which can help rendering pages on the server.