Additional Documentation Frameworks

So far, we have looked at the Swagger and APIdoc libraries. There are many additional tools that can help us in documenting our services and Microservices. In the end, it will come down to the preference of the development team. It is worth talking about Enunciate and the Spring REST docs before we move ahead to the next topic:

  • Enunciate: This is an open source project, licensed under Apache License. It is easy to integrate with existing web projects and has a set of annotations available to support documentation. More information can be found at http://enunciate.webcohesion.com/,https://github.com/stoicflame/enunciate/wiki, which has a sample project code as well.
  • Spring REST docs: Will it be beneficial if we can create our documentation while we are implementing our test cases? That is the thought behind Spring REST docs. Though it does add some dependency on unit testing, it is like killing two birds with one stone. If you are already using the Spring framework, you should definitely give the Spring REST docs a try. For more details and some sample usage, check out https://spring.io/projects/spring-restdocs.
..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset
18.116.65.130