CODEWITHSUNDEEP
springspring-bootswagger-uispringdocspringdoc-openui
codejunkie
codejunkie

Reputation: 968

Unable to access spring-docs-open-ui swagger documentation

I am a spring newbie trying to configure swagger documentation for my spring boot application. I configured my application based on the documentation provided here

I am able to access the documentation page locally from this URL

http://localhost:8080/doc.html

However, when I deploy my application on Docker I keep getting a 404 status.

https://www.mywebsite.com/context_path/doc.html

My application.properties file looks like this - 

springdoc.api-docs.path=/doc
springdoc.swagger-ui.path=/doc.html

I have also added a HomeController which redirects to the documentation page

@Controller
public class HomeController {
    private static final Logger LOGGER = LoggerFactory.getLogger(HomeController.class);
    @RequestMapping(value = "/")
    public void redirect(HttpServletResponse response) throws IOException {
        response.sendRedirect("/doc.html");
    }

}

FYI, I am using Amazon Cognito. I have read and tried several examples that I found online but I cannot make this work. Can someone help me?

Upvotes: 0

Views: 588

Answers (1)

user13447845
user13447845

Reputation:

You are using only @Controller annotation; If you are using REST APIs, you should use @RestController. If you need to use @Controller, you should add @ResponseBody

If you don't want change your @Controller, you add:

static {
    SpringDocUtils.getConfig().addRestControllers(HelloController.class);
}

More information are available on the documentation of F.A.Q:

Upvotes: 1

Related Questions