Swagger ui stuck on unable to infer base url #1996
Comments
|
Couple of things to try...
In any case, you need to override the host name with caution. Its really only to facilitate tweaking if everything else doesnt work. |
|
I cannot bring it up in local because even on local I run the environment with docker compose, hence the edge service is still in front of the main service. |
|
i faced the same problem |
|
I had the same problem using Spring Boot 2.0.0.M4 + Spring Security. This solved my issue: import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
@Configuration
class SecurityConfig extends WebSecurityConfigurerAdapter {
private static final String[] AUTH_WHITELIST = {
// -- swagger ui
"/swagger-resources/**",
"/swagger-ui.html",
"/v2/api-docs",
"/webjars/**"
};
@Override
protected void configure(HttpSecurity http) throws Exception {
http.authorizeRequests()
.antMatchers(AUTH_WHITELIST).permitAll()
.antMatchers("/**/*").denyAll();
}
}I don't know, if the whitelist is complete or correct at all. But it solves the issue described above. |
|
This is somewhat irrelevant now, but what you say has nothing to do with the issue |
|
@logicaleak Ok, thank you - it seems to be the same symptom for a different reason in my case. However, maybe it is useful for someone (like me) googling that error message. Here is what I get if I remove "/swagger-resource/**" from the AUTH_WHITELIST described above:
|
|
@dilipkrish what should the X-FORWARD headers contain? I can bring it up locally just fine, but when deploying behind a load balancer in AWS I get that dreaded "Unable to infer base url" popup |
|
@skozlovich Your X-FORWARD headers would contain your upstream url. For e.g. if you're doing request path based routing in your api gateway https://host/path -> https://upstream:port/ Then your X-Forward headers should reflect the upstream information |
|
Try to clear the browser cache. |
ghost
mentioned this issue
|
I just like to chime in here that I'm seeing this exact same issue. Since the upgrade to Springfox v2.7.0 from v2.4.0 (which fixed #799 - thanks! 😃 ), I'm presented with the same response as in the screenshot above when attempting to view the Swagger UI page. I've tried refreshing cache, switching browsers, and adjusting permissions, even so far as just setting 'permitAll()' to all urls. No luck. I'll keep poking at it and post back here if I come up with anything. FWIW - I've also tried upgrading to the latest Spring Boot (v1.5.9), Spring Security (v4.2.3), and Guava (v23.5-jre). Still getting the same issue |
|
@pedorro You need to find out what path returns a valid json for the path |
|
@dilipkrish thanks for the quick response. I've got a base url path (I think?) by defining the property I think I've gotten everything working by adding a number of explicit redirects for urls that it's unable to find because they are not mapped to that base path. The explicit redirects I've added are:
I discovered this list of required redirects by watching the requests made by swagger-ui.html and seeing which were coming back as 404s. One particularly weird one is that it's looking for the /v2/api-docs json at Anyway, I think I have it working now. Thanks for your help! And for supporting this library! It really is invaluable. |
|
Do you have the annotation on your SpringApplication? |
|
The message is promoted in a catch block which does not determine or throw actual http error code which is confusing for many. In short any problem in invoking and the url or getting the response output will throw this error which could be due to URL context/base path issue, permission issue, spring web container not returning json values etc. ( In my case web container was returning xml and also initially i did not have protected urls ) Best solution from framework point of view will be to catch different exceptions and give appropriate message to users. |
|
I was running into the same issue. Once I allowed all access to /swagger-resources/** I could access the API as normal. Interestingly, for all other resources, the browser is sending the session/credential information. So I assume the bug is not on server side but swagger fails to send the (XMLHttp)Request to swagger-resources without the withCredentials flag set (https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials). So for me the fix was to not require authentication/authorization for /swagger-resources/** resources. |
|
@codernonkey thanks for your suggestion. I believe it was fixed in 2.9.0, so I just wanted to check if that was the version you're using. @jagatrsingh thanks for your input, in this case, since its the browser, you should be able to inspect the console to find out what happened. |
|
@dilipkrish I just upgraded to 2.9.0 and I am still getting this problem. Does Swagger work at all with Spring Security? |
|
You mean swagger-ui? Yes it does, but you need to configure it correctly for it to work. The simplest option is to permit anonymous access to
If thats not an option you'd need to protect some of those resources via basic authentication, typically an authentication mechanism (may be different from the one protecting the APIs themselves). |
|
@dilipkrish I was and am using version 2.8.0 from https://mvnrepository.com/artifact/io.springfox but am not sure if this is the right source as there is no 2.9.0 available? |
|
@codernonkey its available in jcenter. |
|
The solution suggested by @danieldietrich worked for me :-) |
|
Same problem here. |
|
@ropherpanama thanks for sharing your tip |
|
Adding |
|
I am facing the same issue on localhost. I am trying to connect swagger-ui to an existing swagger.json (not auto-generated). Followed this project here but with version 2.9.2 |
|
Available on https://github.com/oeresundsgruppen/swaggerTest |
|
@oeresundsgruppen Thats an old repo that I submitted a PR for to fix your setup. Nothing has changed since. Do you have some commits you haven't pushed perhaps? |
|
The example works under spring-run/java -jar, but not under plain simple tomcat - and hence demonstrates the problems to be resolved. This is unfortunately still open |
I add this annotation, and fix the problem |
|
Indeed I did, are you deploying under tomcat ? |
|
my project is not for springboot . but for spring-mvc 's swagger config class like this: } |
|
I got it working by adding |
|
Version 2.9.2 is not working on AWS ALB, it has same issue as mentioned by oeresundsgruppen commented on 5 Nov 2018. At local it works OK though with localhost. This is the config I have .../swagger-resources/configuration/ui" is being redirected to /api/null/swagger-resources/configuration/ui. /** |
|
Tried all of this until I realized that my swagger config (which I copied from another project) was in the wrong package. |
|
Strangely, mine works fine in the local environment but not in bluemix using the same identical properties.yml file. /v2/api-docs works fine. It does look like springfox tries to return something cryptic: |
|
I resolved it by adding the config package name "com.companyname.api.config" where I have kept my SwaggerConfiguration file in component scan |
|
@jayasvision: Appreciate the suggestion, tried it but no luck. Most likely because all my packages are subpackages of my Application package, so @componentscan has no effect. Update: So it turns out IBM/Cloud Foundry can't figure out how to completely clear out the routes cache when pushing a new app to the cloud. Springfox serves up the content correctly, but one of the link elements doesn't get resolved correctly. Since there are not HTTP error codes returned, I can only assume the request is never received by the app. Although not directly a Springfox issue, that "Unable to infer base URL" popup is misleading and obnoxious and should probably be better handled. |
|
In spring boot application after making these changes in objectMapper swagger stops working changes done are below: If I remove these above changes swagger starts working. |
|
When externalizing swagger invocation into its own class, one should remember to always annotate that class not just with |
|
Hi! |
|
thanks @ktprezes ...... with your solution, i resolved my problem.. |
|
For me adding a bypass (/path/swagger-resources) to return true on token validation worked. Also needed to upgrade my spring version from 4.1.0.RELEASE to 4.2.0.RELEASE to solve internal server error on loading swagger ui. |
|
I had the same issue because of my objectmapper config as mentioned by @tdaskhatri . Once i removed that, it started working fine |
|
Check your Java Version, i had used 11 and it doesn't work, downgraded to Java 8 and it works. |
|
@cpuell I dont think that is true.. check the demo project with java 11. If you have a specific issue you're running into please create a new issue, would love to fix it. |
|
In case helpful to someone, with a Spring Boot application I get this same error without a server.servlet.context-path entry in my application.properties file. |
|
import com.fasterxml.classmate.TypeResolver;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.context.request.async.DeferredResult;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger.web.*;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import springfox.documentation.builders.ResponseBuilder;
import springfox.documentation.schema.ScalarType;
import springfox.documentation.schema.WildcardType;
import java.time.LocalDate;
import java.util.List;
import static java.util.Collections.singletonList;
import static springfox.documentation.schema.AlternateTypeRules.newRule;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
public SwaggerConfig(TypeResolver typeResolver) {
this.typeResolver = typeResolver;
}
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build()
.pathMapping("/")
.directModelSubstitute(LocalDate.class, String.class)
.genericModelSubstitutes(ResponseEntity.class)
.alternateTypeRules(
newRule(typeResolver.resolve(DeferredResult.class,
typeResolver.resolve(ResponseEntity.class, WildcardType.class)),
typeResolver.resolve(WildcardType.class)))
.useDefaultResponseMessages(false)
.globalResponses(HttpMethod.GET,
singletonList(new ResponseBuilder()
.code("500")
.description("500 message")
.representation(MediaType.TEXT_XML)
.apply(r ->
r.model(m ->
m.referenceModel(ref ->
ref.key(k ->
k.qualifiedModelName(q ->
q.namespace("some:namespace")
.name("ERROR"))))))
.build()))
.enableUrlTemplating(true)
.globalRequestParameters(
singletonList(new springfox.documentation.builders.RequestParameterBuilder()
.name("someGlobalParameter")
.description("Description of someGlobalParameter")
.in(ParameterType.QUERY)
.required(true)
.query(q -> q.model(m -> m.scalarModel(ScalarType.STRING)))
.build()));
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Swagger3接口文档")
.description("更多请咨询服务开发者XXX")
.contact(new Contact("作者", "作者地址", "作者邮箱"))
.version("1.0")
.build();
}
@Autowired
private TypeResolver typeResolver;
List<SecurityReference> defaultAuth() {
AuthorizationScope authorizationScope
= new AuthorizationScope("global", "accessEverything");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
return singletonList(
new SecurityReference("mykey", authorizationScopes));
}
private SecurityContext securityContext() {
return SecurityContext.builder()
.securityReferences(defaultAuth())
.forPaths(PathSelectors.regex("/anyPath.*"))
.build();
}
@Bean
UiConfiguration uiConfig() {
return UiConfigurationBuilder.builder()
.deepLinking(true)
.displayOperationId(false)
.defaultModelsExpandDepth(1)
.defaultModelExpandDepth(1)
.defaultModelRendering(ModelRendering.EXAMPLE)
.displayRequestDuration(false)
.docExpansion(DocExpansion.NONE)
.filter(false)
.maxDisplayedTags(null)
.operationsSorter(OperationsSorter.ALPHA)
.showExtensions(false)
.showCommonExtensions(false)
.tagsSorter(TagsSorter.ALPHA)
.supportedSubmitMethods(UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS)
.validatorUrl(null)
.build();
}
} |
|
In my case I made the mistake of placing Swagger config class outside of main application package, moved it to main package of my application and it worked: Bad Ok |
|
In my case, i added a global custom json msg converter and this converter converts the response of 'http://localhost:8089/v2/api-docs' to my custom json format.
|
|
i have the same issue locally, and i don't use spring security or others, all ressource are public ! |
|
I resolved the same problem by just adding the version name like: /v1 in my api paths. `@RestController |
|
I was stuck for a day with this issue. My issue was incorrect port configuration. Check your application.yml/application.properties file for port configuration. There I had mistakenly added both |
|
getting the same issue |
|
I have the same issue, stuck 1 day, not resoved yet. Questions about this issue are all over the search engines for yeas. Is it neccesary to be like this? |
and others
Hello,
I am trying to run swagger-ui via springfox. My service is behind an edge service, and from swagger I am constantly getting the error :
My docket config is as follows
I have tried different possibilities of host configuration, including not providing it at all.
I can access the docs json from
http://localhost:8999/v2/api-docsjust fine.When I try to set the base url through this message, no matter what I enter, the dialog flickers and just stands there. I check the network and the browser makes a request to /configuration, which seems to return 200.
I have no idea what to do at this point. Does anyone have any idea ?
The text was updated successfully, but these errors were encountered: