Now available on docslikecode.com, this explanation of how to integrate Swagger with Swashbuckle for a REST API written with C#.
A Pirate’s Life for Me: Documenting APIs with Swagger
In it, Adam Locke, their lone tech writer, describes his troubleshooting process, the toolset including DapperDocs, OpenAPI, Nuget, Packet, and some clever code.
I appreciate reading about both the stop-and-start struggles and the clear wins found in this case study. Plus, it provides insights into how REST APIs can be written in any programming language. I have found it’s best to lean into the language your coworkers know best. Then you can get the collaboration gains offered by integrating the docs and code as tightly as possible.