Package org.heigit.ohsome.ohsomeapi.config

Class SwaggerConfig

java.lang.Object
org.heigit.ohsome.ohsomeapi.config.SwaggerConfig
All Implemented Interfaces:
com.google.common.base.Supplier<List<springfox.documentation.swagger.web.SwaggerResource>>, Supplier<List<springfox.documentation.swagger.web.SwaggerResource>>, springfox.documentation.swagger.web.SwaggerResourcesProvider
@Configuration @EnableSwagger2 @PropertySource("classpath:application.properties") @Primary public class SwaggerConfig extends Object implements springfox.documentation.swagger.web.SwaggerResourcesProvider
Swagger configuration class.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SwaggerConfig(springfox.documentation.swagger.web.InMemorySwaggerResourcesProvider resourcesProvider)
    Creates swagger configuration object, initializes internal specs sorting table.

  • Method Summary

    Modifier and Type
    Method
    Description
    springfox.documentation.spring.web.plugins.Docket
    dataAggregationDocket()
    Creates the Swagger2 documentation for the data aggregation resources.
    springfox.documentation.spring.web.plugins.Docket
    dataExtractionDocket()
    Creates the Swagger2 documentation for the data extraction resources.
    List<springfox.documentation.swagger.web.SwaggerResource>
    get()
     
    springfox.documentation.spring.web.plugins.Docket
    metadataDocket()
    Creates the Swagger2 documentation for the metadata resources.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SwaggerConfig

      @Autowired public SwaggerConfig(springfox.documentation.swagger.web.InMemorySwaggerResourcesProvider resourcesProvider)
      Creates swagger configuration object, initializes internal specs sorting table.

  • Method Details

    • get

      public List<springfox.documentation.swagger.web.SwaggerResource> get()
      Specified by:
      get in interface com.google.common.base.Supplier<List<springfox.documentation.swagger.web.SwaggerResource>>
      Specified by:
      get in interface Supplier<List<springfox.documentation.swagger.web.SwaggerResource>>

    • dataAggregationDocket

      @Bean public springfox.documentation.spring.web.plugins.Docket dataAggregationDocket()
      Creates the Swagger2 documentation for the data aggregation resources.

    • metadataDocket

      @Bean public springfox.documentation.spring.web.plugins.Docket metadataDocket()
      Creates the Swagger2 documentation for the metadata resources.

    • dataExtractionDocket

      @Bean public springfox.documentation.spring.web.plugins.Docket dataExtractionDocket()
      Creates the Swagger2 documentation for the data extraction resources.