Hello Hive and Java Developers and the rest,

as I wrote in my last post, I am setting up a java springboot server, which, when it is finished somewhere far in the future, shall contain a new game "Hamurabi", which will be connected to hive.

Here, in this post, I show, how I have set up Swagger and Postman:

This documentation is based on: @achimmertens/hamurabi-spring-boot-server

Swagger

https://swagger.io/

I have added the following to pom.xml:


<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

To avoid the error message "Failed to start bean 'documentationPluginsBootstrapper';"
I have added into application.properties:

#======================================
# Swagger
#======================================
spring.mvc.pathmatch.matching-strategy=ant-path-matcher

I have created the config file swagger.config in the configuration package:

Here is its content:

package org.chary.configuration;

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;

@Configuration
@EnableSwagger2
public class SwaggerConfig {


    public static final Contact DEFAULT_CONTACT = new Contact(
            "Achim Mertens", "http://peakd.com/@achimmertens", "[email protected]");

    private static final Set<String> DEFAULT_PRODUCES_AND_CONSUMES =
            new HashSet<String>(Arrays.asList("application/json","application/xml"));

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(SwaggerConfig.apiInfo())
                .produces(DEFAULT_PRODUCES_AND_CONSUMES)
                .consumes(DEFAULT_PRODUCES_AND_CONSUMES);
    }

    private static ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("Swagger API")
                .description("Swagger API reference for developers")
                .version("2.0")
                .contact(DEFAULT_CONTACT)
                .termsOfServiceUrl("http://peakd.com/@achimmertens")
                .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0").build();
    }
}