Using Spring REST Docs with automated tests

-

 

Spring REST docs provide a lot of features and flexibility to generate documentation for your REST APIs. One of the powers of REST docs is its ability to generate the documentation based on the unit tests which ensure that documentation is accurate, concise, and well-structured.

To enable the Spring REST Docs support, add spring-restdocs-mockmvc as an additional dependency in your application. 


Spring REST Docs use the test cases to generate accurate and updated documentation for the REST API.

If all tests pass with no issue, it will generate a sub-folder under the target/generated-snippets with a name matching the argument passed to the document method (in our case it is itShouldReturnThreeCustomers). There will be several .adoc files.

One of the limitations with the AsciiDoc doc is that it is unable to render in the browser. So AsciiDoc need to be converted into a browser-friendly format like HTML. To convert our documentation into HTML format, must be use the AsciiDoctor maven plugin.

To make sure generated .adoc snippets and AsciiDoctor Maven plugin working together to generate the documentation, we need to glue together the generated .adoc files. We need to create a new file index.adoc under src/main/asciidoc directory.



Go to source code

Comments

Post a Comment

Popular posts from this blog

Debug Java Stream in Intellij Idea

-
Image
Stream is a very powerful feature. it allows you to take full advantage of modern multi-core architectures and lets you process data in a declarative way.  Unfortunately stream API may sometimes be difficult to debug. This happens because they require you to insert additional breakpoints and thoroughly analyze each transformation inside the stream.  IntelliJ IDEA provides a solution to this by letting you visualize what is going on in Java Stream operations. Just install plugin called “Java Stream Debugger”. Once you have enabled this plugin you can simply debug your code. This plugin will bring a trace icon (Trace Current Stream Chain button).   Trace Current Stream Chain button Once you click on that icon you get the visualization of your stream pipeline.  For every stream operation, we have got a dedicated tab. you have to switch to the relevant tab to understand what it is doing. 
Read more

Creating Efficient Docker Images with Spring Boot 2.3

-
Image
Spring Boot 2.3 brings with it some interesting new features that can help you package up your Spring Boot application into Docker images. The first problem with common docker techniques is that the jar file is not unpacked. There’s always a certain amount of overhead when running a fat jar, and in a containerized environment this can be noticeable. It’s generally best to unpack your jar and run in an exploded form. The second issue with the file is that it isn’t very efficient if you frequently update your application. Docker images are built in layers, and in this case your application and all its dependencies are put into a single layer. Since you probably recompile your code more often than you upgrade the version of Spring Boot you use, it’s often better to separate things a bit more. If you put jar files in the layer before your application classes, Docker often only needs to change the very bottom layer and can pick others up from its cache. Two new features are introduced in Sp...
Read more

CRUD Goes Even Easier With JPABuddy

-
Image
Create, Read, Update and Delete are the four basic operations of persistence storage. We can say these operations collectively as an acronym CRUD. These operations can be implemented in JPA. JPA is a standard for ORM. It is an API layer that maps Java objects to the database tables.  ORM stands for Object Relational Mapping. It converts data between incompatible type systems in object-oriented programming languages.  JPA Buddy is an IntelliJ IDEA plugin that helps developers work efficiently. JPA Buddy is a tool that is supposed to become your faithful coding assistant for projects with JPA and everything related. It is an advanced plugin for IntelliJ IDEA intended to simplify and accelerate everything related to JPA and surrounding mainstream technology. In fact, you can develop an entire CRUD application or a simple microservice by spending nearly zero time writing boilerplate code. The video demonstrates the features of JPA Buddy by creating a simple CRUD application from ...
Read more