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.
 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <version>2.6.1</version>
     <scope>compile</scope>
 </dependency>

 <dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.6.1</version>
     <scope>compile</scope>
 </dependency>

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. 
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select().apis(RequestHandlerSelectors.basePackage("com.myorg.demo.rest"))
                .paths(p->p.startsWith("/"))
                .build()
                .apiInfo(new ApiInfo(
                        "Web scrapper API",
                        "Web Scrapper service for news articles",
                        "1.0",
                        "http://localhost:8081/termsOfService.html",
                        new Contact("Demo user", "http://localhost:8081/about", "demo@myorg.com"),
                       "Service license 1.0",
                        "https://localhost:8081/license1.0.html"));
    }
}
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.

Comments

Popular Posts

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 "property.name" 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 all prop…

Asynchronous REST service implementation in Spring boot

In this tutorial we will see how to create an asynchronous REST service endpoint using Spring boot application.
Asynchronous service works in a way that it will not block the client request and do the processing in separate thread. When work is complete the response returned to the client so our service will be able to handle more client requests at the same time, compare to synchronous processing model.
Let's understand how it is working in synchronous mode. In such server/client application at server side it has a pool of threads which are serving the request. If a request received by a thread then it will be blocked until it send the response back to client. In this case if processing doesn't take much time it will be able to process it quickly and accept other client requests but there could be one situation when all threads are busy and not able to accept the new client requests.

To overcome of such problems, asynchronous processing model introduced for REST services. In…

Entity to DTO conversion in Java using Jackson

It's very common to have the DTO class for a given entity in any application. When persisting data, we use entity objects and when we need to provide the data to end user/application we use DTO class. Due to this we may need to have similar properties on DTO class as we have in our Entity class and to share the data we populate DTO objects using entity objects. To do this we may need to call getter on entity and then setter on DTO for the same data which increases number of code line. Also if number of DTOs are high then we need to write lot of code to just get and set the values or vice-versa.
To overcome this problem we are going to use Jackson API and will see how to do it with minimal code only.
Maven dependency <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.9</version> </dependency> Entity class Below is our ent…

Web scraper using JSoup and Spring Boot

What is webscraping Webscraping is a technique to extract or pull the data from a website to gather required information by parsing the HTML source of their websites, such as articles from news or books site, products information from online shopping sites or course information from education sites. There are many organisations who uses web scraper to provide the best experience to their customers, for example extract the price for a smartphone from multiple online websites and show their customers the best and cheap product URL.
We will learn here how to code a web scraper by developing a simple new scraper service.
News scraper News scraper is used to extract the news articles or other related contents from a news site. Here we are going to create a web scraper application to pull the articles from news site.
Below are the operations provided by our news scraper service.
List all the authorsSearch articles by author nameSearch articles by article titleSearch articles by article desc…