2

I'm having a bit of trouble making Swagger display API docs using Restlet. What Swagger shows is just these stuff:

enter image description here

And checking the api-docs it only shows this:

enter image description here

I wonder what is wrong with my code:

public class MyApplication extends SwaggerApplication {
    private static final String ROOT_URI = "/";
    public Restlet createInboundRoot() {
        Router router = new Router(getContext());
        router.attach(ROOT_URI, RootServerResource.class);
        router.attach(ROOT_URI + "ping", PingServerResource.class);
        router.attach(ROOT_URI + "ping/", PingServerResource.class);
        // Some code omitted for simplicity
        return router;
    }
}
quarks
  • 33,478
  • 73
  • 290
  • 513
  • If you are using Spring Security, use the security configuration mentioned on **[Cannot open Swagger UI in tis Version 3 in my Spring Boot Example](https://stackoverflow.com/questions/73073519/cannot-open-swagger-ui-in-tis-version-3-in-my-spring-boot-example)** page. – Murat Yıldız Jan 31 '23 at 10:14

3 Answers3

2

You could have a look at this article:

Both Swagger1 and 2 are supported by the Swagger extension of Restlet:

  • Swagger v1

    public class ContactsApplication extends SwaggerApplication {
    public Restlet createInboundRoot() {
        Router router = new Router();
        (...)
        attachSwaggerSpecificationRestlet(router, "/docs");

        return router;
    }
}

  • Swagger v2

    public class ContactsApplication extends Application {
   public Restlet createInboundRoot() {
        Router router = new Router();
        (...)
        Swagger2SpecificationRestlet swagger2SpecificationRestlet
                               = new Swagger2SpecificationRestlet(this);
        swagger2SpecificationRestlet.setBasePath("http://myapp.org/");
        swagger2SpecificationRestlet.attach(router, "/docs");
        return router;
    }
}
Thierry Templier
  • 198,364
  • 44
  • 396
  • 360
1

The solution is to add this code:

    // Configuring Swagger 2 support
    Swagger2SpecificationRestlet swagger2SpecificationRestlet
            = new Swagger2SpecificationRestlet(this);
    swagger2SpecificationRestlet.setBasePath("http://localhost:8080/api-docs");
    swagger2SpecificationRestlet.attach(router);

And point the Swagger UI to /swagger.json

quarks
  • 33,478
  • 73
  • 290
  • 513
0

Swagger needs to find your API operations. I'm not sure about Restlet, in Jersey you annotate your REST resource classes with @Api and your methods with @ApiOperation. Read more here in the swagger docs.

Johannes Kienzle
  • 58
  • 10