Swagger

Easily visualize and interact with your REST API

\u0000<p align="center">\n<a href="https://vaadin.com/directory/component/swagger\" target="__blank"><img src="https://user-images.githubusercontent.com/60381251/176435959-29c48982-bbc5-43d0-8769-084074d8c9a3.png\" alt="Vaadin Swagger">\n
\n<a href="https://vaadin.com/directory/component/swagger\"><img alt="Vaadin Directory" src="https://img.shields.io/vaadin-directory/status/swagger?color=6D9A00\">\n<a href="https://vaadin.com/directory/component/swagger\"><img alt="Vaadin Directory version" src="https://img.shields.io/vaadin-directory/v/swagger?color=6D9A00&label=%20\">\n<a href="https://vaadin.com/directory/component/swagger\"><img alt="Vaadin Directory" src="https://img.shields.io/vaadin-directory/stars/swagger?color=6D9A00\">\n<a href="https://preview.f0rce.de/vaadin-swagger/\" target="__blank"><img src="https://img.shields.io/static/v1?label=&message=Demo&color=6D9A00\" alt="Demo">\n
\n<a href="https://github.com/f0rce/vaadin-swagger\" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/f0rce/vaadin-swagger?style=social\">\n

Sample code

@Route("")
public class TestView extends Div {

  public TestView() {
    // Set the parent <div> to full size (fullscreen)
    this.setSizeFull();

    // Initialize new SwaggerEditor aka SplitView with AceEditor as primary and SwaggerUI as
    // secondary
    SwaggerEditor swaggerEditor = new SwaggerEditor();

    // Add the spec as soon as SwaggerUI is ready --> this is not neccessary, as the frontend
    // handles it automatically
    swaggerEditor
        .getSwaggerUI()
        .addReadyListener(
            event -> {
              // OpenAPI 3.0 sample
              swaggerEditor.setSpec(
                  "openapi: 3.0.0\n"
                      + "info:\n"
                      + "  version: 1.0.0\n"
                      + "  title: Sample API\n"
                      + "  description: A sample API to illustrate OpenAPI concepts\n"
                      + "paths:\n"
                      + "  /list:\n"
                      + "    get:\n"
                      + "      description: Returns a list of stuff              \n"
                      + "      responses:\n"
                      + "        '200':\n"
                      + "          description: Successful response");
            });

    // Add SwaggerEditor to the parent <div>
    this.add(swaggerEditor);
  }
}

@Route("")
public class TestView extends Div {

  public TestView() {
    // Set the parent <div> to full size (fullscreen)
    this.setSizeFull();

    // Initialize new SwaggerUI
    SwaggerUI swaggerUI = new SwaggerUI();

    // Set the size to fullscreen to match parents height/width
    swaggerUI.setSizeFull();

    swaggerUI.addReadyListener(
        event -> {
          // OpenAPI 3.0 sample
          swaggerUI.setSpec(
              "openapi: 3.0.0\n"
                  + "info:\n"
                  + "  version: 1.0.0\n"
                  + "  title: Sample API\n"
                  + "  description: A sample API to illustrate OpenAPI concepts\n"
                  + "paths:\n"
                  + "  /list:\n"
                  + "    get:\n"
                  + "      description: Returns a list of stuff              \n"
                  + "      responses:\n"
                  + "        '200':\n"
                  + "          description: Successful response");
        });

    // Add SwaggerUI to the parent <div>
    this.add(swaggerUI)
  }
}

SwaggerEditor swaggerEditor = new SwaggerEditor();
AceEditor ace = swaggerEditor.getAceEditor();

// turn of read-only mode
ace.setReadOnly(false);

Links

• View on GitHub
• Author Homepage
• Issue tracker

Compatibility