Spring Rest Docs - Documenting REST API | Example | Java Techie 

Thanks Devesh 🥰

Hi Bhupathi, glad to hear this , webtestclient will be same approach instead of mickmvc.perform() we can use this test web client But anyway as I already uploaded this content , If you really need let me know I will share code with you . Wait for Spring Auto Rest Docs 😜, it will be more interesting , you no need to do anything

@@Javatechie please share me code , really tried lot of ways , I'm not succeed with webTestClint , advanced TQ

@@aswarthanarayanareddyb176 Will share it tomorrow k

@@Javatechie TQ

@@aswarthanarayanareddyb176 just add below piece of code in @BeforeEach annotated method @Autowired private ApplicationContext context; protected WebTestClient webTestClient; @Rule public final JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation(); @Before public void setUp() throws Exception { this.webTestClient = WebTestClient .bindToApplicationContext(context) .apply(springSecurity()) .configureClient() .baseUrl("localhost:8080/") .filter(documentationConfiguration(restDocumentation) .snippets() .withDefaults(WebTestClientInitializer.prepareSnippets(context), CliDocumentation.curlRequest(), HttpDocumentation.httpRequest(), HttpDocumentation.httpResponse(), AutoDocumentation.requestFields(), AutoDocumentation.responseFields(), AutoDocumentation.pathParameters(), AutoDocumentation.requestParameters(), AutoDocumentation.description(), AutoDocumentation.methodAndPath(), AutoDocumentation.section())) .build(); }

Either you can return status code from controller using ResponseEntity as return type and set status code Else you can add annotation

This is not the concept of documenting your api with spring rest docs. ( In gerneral with rest api ). Keep in mind that the rest api uses standard status codes and http verbs. Instead of documenting them all, follow the standard like your client will. E.g. If the client wints to create a student with a username that already exists, a 409 should be thrown. That is intuitiv and doesn't need additinal documentation. If you want to document it, do it in you index file e.g. with a hand made table

@@agguLi could you please help me to understand purpose of using Spring Rest docs ?

@@Javatechie Spring rest-docs has many advantages e.g. compared with swagger. It is test-driven, so your docs are always correct ( Ofcourse the test are correct ). It is written mark down like( ascii-doc) so you give the client a better api overview of the funcionality with more semantics than just throwing a bunch of url on him. Next, the documentation is decoupled from your implementatino files. If you look at a bigger swagger project, there are many annotations, sometimes more than code. And it leady you to repeat yourself which brings the risk of diverging you api docs from implementation. Another point is, that swagger is heavy. If you scale your api this could be costy. Also, swagger doesn't handle hypermedia ( if this hasn't been included in the last couple of months ). So as you can see, rest docs has a big purpose. If you want to account that I've saif you shouldn't mention every status code, that is because rest with it's http verbs and status codes follows that is already well documented. So there is ne need to document a behaviour that follows an already defined standard. If you have to use some custom exceptions of course you have to define them. Bur rest docs doesn't generate that by default because you should only document the success behaviour of you request.

Source code link mentioned in video description