Skip to main content

Swagger2 implementation in Spring boot

What is Swagger

Using swagger we can describe our REST APIs without much effort. We just need to do some minimal configuration and it provides a complete UI which describes all our endpoints along with interface to execute them using web browser without any additional plugin. Also it is customisable so we can add descriptions and other orchestration to our APIs.

Why Swagger

When we have a REST API and we want to share it with our users, we need to provide them all the documentation and specification for our APIs which requires some effort to prepare them. With the help of Swagger UI we can share the Swagger URL for our service where users not only see all the listed operations but they can play also with those APIs using web browser.

Implementing Swagger in Spring boot application

Now we will see how to use Swagger in our spring boot application.

Maven dependencies

Below dependencies are required for Swagger. "sringfor-swagger-ui" is required if you want Swagger to create UI for you. If you want to create your own UI then you can ignore dependencies for swagger-ui but you need springfox-swagger2 which creates REST based documentation for your API.


Swagger configuration

Now we need to create the configuration to enable the Swagger. Only this configuration can be enough if we don't want to customise the Swagger and let Swagger create the default documentation for our APIs. 
public class SwaggerConfig {
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfo(
                        "Web scrapper API",
                        "Web Scrapper service for news articles",
                        new Contact("Demo user", "http://localhost:8081/about", ""),
                       "Service license 1.0",
That's it. Now you can run the application and hit the given URLs in web browser.
         This URL shows your API documentation generated by Swagger in JSON format as given below.

swagger doc resource

          Open this URL in web browser and click "Show/Hide" link. You will see the similar screen as given below.

swagger ui home page

Customizing Swagger

We can customise the swagger documentation using annotations to add more details description. For example, below code adding operations description and response types in REST endpoint.
@ApiOperation(value = "Search articles by author name")
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "Success response"),
            @ApiResponse(code = 401, message = "Resource not authorized"),
            @ApiResponse(code = 403, message = "Access forbidden"),
            @ApiResponse(code = 404, message = "Resource not found")
 @RequestMapping(value="/by-author/{authorName}", method = RequestMethod.GET, produces = "application/json")
 public List<Article> searchArticlesByAuthor(@PathVariable("authorName") String authorName) {
See the below screenshot after adding above annotations.
swagger operation execution

We can add the details to entities or domain objects also which are used in REST endpoints, like in below code we have added some meaningful description to domain model.
@ApiModel(value="Article", description="News article")
public class Article implements Serializable{
    private static final long serialVersionUID = 1L;

    @ApiModelProperty("Title for article")
    private String title;

    @ApiModelProperty("Article description")
    private String description;

    @ApiModelProperty("Author name")
    private String authorName;
See below screenshot which reflects the changes related to domain object.
swagger api details

This concludes the implementation of Swagger but Swagger is not limited to this only. We can do a more valuable things with it, like client code generation, test automation etc.


Popular Posts

Setting up kerberos in Mac OS X

Kerberos in MAC OS X Kerberos authentication allows the computers in same domain network to authenticate certain services with prompting the user for credentials. MAC OS X comes with Heimdal Kerberos which is an alternate implementation of the kerberos and uses LDAP as identity management database. Here we are going to learn how to setup a kerberos on MAC OS X which we will configure latter in our application. Installing Kerberos In MAC we can use Homebrew for installing any software package. Homebrew makes it very easy to install the kerberos by just executing a simple command as given below. brew install krb5 Once installation is complete, we need to set the below export commands in user's profile which will make the kerberos utility commands and compiler available to execute from anywhere. Open user's bash profile: vi ~/.bash_profile Add below lines: export PATH=/usr/local/opt/krb5/bin:$PATH export PATH=/usr/local/opt/krb5/sbin:$PATH export LDFLAGS=&

SpringBoot - @ConditionalOnProperty example for conditional bean initialization

@ConditionalOnProperty annotation is used to check if specified property available in the environment or it matches some specific value so it can control the execution of some part of code like bean creation. It may be useful in many cases for example enable/disable service if specific property is available. Below are the attributes which can be used for property check. havingValue - Provide the value which need to check against specified property otherwise it will check that value should not be false. matchIfMissing - If true it will match the condition and execute the annotated code when property itself is not available in environment. name - Name of the property to be tested. If you want to test single property then you can directly put the property name as string like "" and if you have multiple properties to test then you can put the names like {"prop.name1","prop.name2"} prefix - It can be use when you want to apply some prefix to

Why HashMap key should be immutable in java

HashMap is used to store the data in key, value pair where key is unique and value can be store or retrieve using the key. Any class can be a candidate for the map key if it follows below rules. 1. Overrides hashcode() and equals() method.   Map stores the data using hashcode() and equals() method from key. To store a value against a given key, map first calls key's hashcode() and then uses it to calculate the index position in backed array by applying some hashing function. For each index position it has a bucket which is a LinkedList and changed to Node from java 8. Then it will iterate through all the element and will check the equality with key by calling it's equals() method if a match is found, it will update the value with the new value otherwise it will add the new entry with given key and value. In the same way it check for the existing key when get() is called. If it finds a match for given key in the bucket with given hashcode(), it will return the value other

jaxb2-maven-plugin to generate java code from XSD schema

In this tutorial I will show how to generate the Java source code from XSD schema. I will use jaxb2-maven-plugin to generate the code using XSD file which will be declared in pom.xml to make it part of build, so when maven build is executed it will generate the java code using XSD. Class generation can be controlled in plugin configuration. Maven changes (pom.xml) Include below plugin in your pom.xml. Here we have done some configuration under configuration section as given below. schemaDirectory : This is the directory where I keep my schema (XSD file). outputDirectory : This is the java source location where I want to generate the Java files. If it is not given then by default it will be generate inside target folder. clearOutputDir : If this property is true then it will generate the classes on each build otherwise it will generate only if output directory is empty. <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>jaxb2-maven-plugin</art