Easy and Fast API Delivery with Swagger

The Way It Was

• Sulit untuk membuat dokumentasi yang jelas, detil, terstruktur dan terorganisir dengan baik. If only dibuat standarisasi format mengenai bagaimana dokumen ini dibuat, dokumentasi semacam ini akan sulit untuk dikonsumsi.

• Additional softwares are needed. Dengan menggunakan tools seperti Word atau Excel, kita memerlukan software tersebut ter-install dan tanpa adanya program ini, dokumentasi tidak dapat digunakan.

• Dokumen semacam ini biasanya statis dan tidak seamless untuk proses update dan collaboration. Artinya, apabila changes terjadi pada API, dokumentasi ini akan dengan cepat menjadi outdated dan sulit di-maintain.

How Swagger will Change Your Life

Let's Do It

<!-- SWAGGER -->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-boot-starter</artifactId>
	<version>3.0.0</version>
</dependency>
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>3.0.0</version>
</dependency>

package com.bca.adam.config;

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

import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bca.adam"))
                .paths(PathSelectors.any())
                .build();
    }
}

package com.bca.adam;

...

import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication
@ComponentScan(basePackages = "com.bca.adam")
@EnableWebMvc
@EnableSwagger2
public class AdamApplication {

	...

	@Bean
	public InternalResourceViewResolver defaultViewResolver() {
		return new InternalResourceViewResolver();
	}
}

Show Time!