Swagger REST API documentation with Spring Boot

Question

I want to use Swagger 2.0 with my Spring Boot RESTful web service to generate documentation. I have searched quite a bit for an answer to this. Basically I have a Spring Boot project with a set of controllers and I want to document the API's. I have the following dependencies setup in my POM file.

<dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.4.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.5.0</version>
    </dependency>

This is my Swagger configuration class with the @Configuration and @EnableSwagger2:

      @Configuration
      @EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.regex("/api/.*"))
            .build()
            .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
            .title("My application title")
            .description("This is a test of documenting EST API's")
            .version("V1.2")
            .termsOfServiceUrl("http://terms-of-services.url")
            .license("LICENSE")
            .licenseUrl("http://url-to-license.com")
            .build();
    }

}

From what I have gathered in reading a couple of other answers here that at this point I should be able to see something at a URL such as http://myapp/v2/api-docs or alternatively http://localhost:8080/myapp/api-docs I have made the assumption that the "myapp" portion of the above URL refers to the name of the class in which my main resides (is this correct)? Also I have tried this with port 8080 and port 80 and the bottom line is that I see nothing other than site can't be reached. I have looked at the answers provided here and here however I'm not having any success. Any help would be much appreciated, thank you in advance.

Simple configuration - https://stackoverflow.com/a/64333853/410439 — Ravi Parekh, Feb 18 '21 at 15:03

score 1 · Answer 1 · answered Feb 20 '17 at 22:37

1

As you can see on the following documentation : https://springfox.github.io/springfox/docs/snapshot/#springfox-swagger-ui

The endpoint is now on swagger-ui.html, for your case, it will be http://localhost:8080/myapp/swagger-ui.html

answered Feb 20 '17 at 22:37

fbak

11
3

Thank you, an additional question, the "myapp" portion of the URL is this the name of the class in which my "main" resides? – TKPhillyBurb Feb 21 '17 at 12:59
I'm not even seeing the port 8080 being used when looking at netstat. – TKPhillyBurb Feb 21 '17 at 13:50
http://stackoverflow.com/questions/24452072/how-do-i-choose-the-url-for-my-spring-boot-webapp – fbak Feb 22 '17 at 09:35

score 0 · Answer 2 · edited Mar 15 '22 at 11:34

0

I used, <artifactId>springdoc-openapi-ui</artifactId> with

public class OpenApiConfiguration{

     @Bean
     public GroupedOpenApi abcApp(){
        String[] abcAppRootPath={"com.stockoverflow.swagger"};
        return GroupedOpenApi.builder().group("my app").packagesToScan(abcAppRootPath).build();
    }
}

reference : https://springdoc.org/#getting-started

edited Mar 15 '22 at 11:34

Suraj Rao

28,850
10
94
99

answered Mar 15 '22 at 11:32

G Krishna

91
1
4

Swagger REST API documentation with Spring Boot

2 Answers2