Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger with specification from file, won't load #2321

Closed
xsmrcek opened this issue Jul 25, 2023 · 1 comment
Closed

Swagger with specification from file, won't load #2321

xsmrcek opened this issue Jul 25, 2023 · 1 comment
Labels
question Further information is requested

Comments

@xsmrcek
Copy link

xsmrcek commented Jul 25, 2023

Hello,
I am trying to run use swagger with my custom OAS speficication.

My configuration:

   @Configuration
   class SpringDocsConfiguration {

    @Bean
    fun oasRouter() : RouterFunction<ServerResponse> = resources("/**", ClassPathResource("static/"))

    @Bean
    fun springDocConfiguration(): SpringDocConfiguration {
        return SpringDocConfiguration()
    }

    @Bean
    fun springDocConfigProperties(): SpringDocConfigProperties {
        return SpringDocConfigProperties()
    }

    @Bean
    fun objectMapperProvider(springDocConfigProperties: SpringDocConfigProperties?): ObjectMapperProvider? {
        return ObjectMapperProvider(springDocConfigProperties)
    }
    }

My pom.xml:

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.1.2</version>
        <relativePath/>
    </parent>
    ...
        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
            <version>2.1.0</version>
        </dependency>

        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-common</artifactId>
            <version>2.1.0</version>
        </dependency>
    ...

My applicatoin.yml:

springdoc:
  swagger-ui:
    enabled: true 
    url: /api-docs.yml
  api-docs:
    enabled: false 

File with api docs is lcoated inr esources folder (src/main/kotlin/resources/static).

When I try to open swagger url, it won't load. Can you please helm me a little? I wasn't able to find guide for my solution.

@bnasslahsen
Copy link
Contributor

bnasslahsen commented Jul 29, 2023

@xsmrcek,

Add this bean:

@Bean
SpringDocUIConfiguration springDocsUiConfiguration(Optional<SwaggerUiConfigProperties> optionalSwaggerUiConfigProperties){
    return new SpringDocUIConfiguration(optionalSwaggerUiConfigProperties);
}

Documentation is already updated and will be published very soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants