This is actually straightforward. I am doing this on a couple of projects.

Three things need to be done,

Create an endpoint that serves the openapi.json file
Create a resources/swaggerui.html
Create an endpoint to serve the html file

src/main/resources
├── config
│   ├── openapi.json
│   └── openapi.yaml
└── swaggerui.html

The HTML file

<html>
<head>
    <title>OpenAPI Spec</title>
    <!-- https://cdnjs.com/libraries/swagger-ui -->
    <link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.17.6/swagger-ui.css">
</head>
<body>
<div id="swagger-ui"></div>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.17.6/swagger-ui-bundle.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.17.6/swagger-ui-standalone-preset.js"></script>
<script>
    window.onload = function () {
        window.ui = SwaggerUIBundle({
            url: "/spec.json",
            dom_id: '#swagger-ui',
            presets: [
                SwaggerUIBundle.presets.apis,
                SwaggerUIStandalonePreset
            ]
        });
    }
</script>
</body>
</html>

Handler

package com.foobar.service.handler;

import com.networknt.config.Config;
import com.networknt.handler.HandlerProvider;
import com.networknt.health.HealthGetHandler;
import com.networknt.info.ServerInfoGetHandler;
import io.undertow.Handlers;
import io.undertow.server.HttpHandler;
import io.undertow.server.HttpServerExchange;
import io.undertow.util.HttpString;
import io.undertow.util.Methods;

public class ApiHandlerProvider implements HandlerProvider {
  @Override
  public HttpHandler getHandler() {

    return Handlers.routing()
        // Metadata
        .add(Methods.GET, "/health", new HealthGetHandler())
        .add(Methods.GET, "/server/info", new ServerInfoGetHandler())

        // Spec
        .add(Methods.GET, "/spec.html", new StaticFileHandler("swaggerui.html", "text/html"))
        .add(Methods.GET, "/spec.yaml", new StaticFileHandler("openapi.yaml", "text/yaml"))
        .add(Methods.GET, "/spec.json", new StaticFileHandler("openapi.json", "application/json"))
        ;
  }

  private static class StaticFileHandler implements HttpHandler {
    private final String filename;
    private final String contentType;

    private StaticFileHandler(final String filename, final String contentType) {
      this.filename = filename;
      this.contentType = contentType;
    }

    @Override
    public void handleRequest(HttpServerExchange exchange) throws Exception {
      final String payload = Config.getInstance().getStringFromFile(filename);
      exchange.getResponseHeaders().add(new HttpString("Content-Type"), contentType);
      exchange.getResponseSender().send(payload);
    }
  }
}

add an endpoint to serve swagger-ui for manual testing #30

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions