4 ms·
We like to use swagger to document the endpoints / payloads etc for REST APIs For other stuff we tend to just provide diagrams of servers/cloud services etc. R
by thorin 5y ago
We like to use swagger to document the endpoints / payloads etc for REST APIs
For other stuff we tend to just provide diagrams of servers/cloud services etc. Really the only way to understand it fully is to look at the code, but at least it's nice to have an entry point to the correct place. Unfortunately there are lots of non technical architects in my organization who tend to depend on documentation (which we have in confluence). It's not ideal really!