com.formkiq.server.config.SwaggerConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of formkiq-server Show documentation

Server-side integration for the FormKiQ ios application

There is a newer version: 0.6.1

package com.formkiq.server.config;

import static springfox.documentation.builders.PathSelectors.regex;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger Config.
 *
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * @return {@link Docket}
     */
    @Bean
    public Docket apiDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("api")
                .apiInfo(apiInfo())
                .select()
                .paths(regex("/api.*"))
                .build();
    }

    /**
     * @return {@link ApiInfo}
     */
    private ApiInfo apiInfo() {
        String licenseUrl =
                "https://github.com/formkiq/formkiq-server/blob/master/LICENSE";

        return new ApiInfoBuilder().title("FormKiQ Api")
                .description("FormKiQ Api with Swagger")
                .license("Apache License Version 2.0")
                .licenseUrl(licenseUrl)
                .version("v1").build();
    }
}