From the course: Software Architecture: Breaking a Monolith into Microservices
Join today to access over 22,500 courses taught by industry experts or purchase this course individually.
Provide up-to-date API documentation with Swagger
From the course: Software Architecture: Breaking a Monolith into Microservices
Provide up-to-date API documentation with Swagger
- Conway's law tells us that system mirror organizational structures and communication patterns. As such, well-defined interfaces between systems, as well as between people, are important to make your microservice migration a success. At Cheaper, you already learned that you have to do way more than just design systems. You have to find new ways of cooperation and rearchitecture the organization along with the code. And here, documentation and processes are key. Previously, I simply painted a few boxes for the REST API, but do we actually know how the data should be provided to the update route in our picture? Will it be a post or a put request, and how should the payload look like? Without the proper API documentation, getting alignment on this will create a lot of friction and noise. Why not automatically generate API documentation from code? The tool of choice to do this today is called swagger. It comes with a software…
Download courses and learn on the go
Watch courses on your mobile device without an internet connection. Download courses using your iOS or Android LinkedIn Learning app.