Open api is a standard for documenting API’s
I think it was initially developed by a company called Swagger.
With the standard comes many benefits… mostly to other programmers.
Here is what i found so far
Asp.net Core
Where i develop my api layer
swashbuckle
one nuget package, and some coding to the startup routines cause the library to generate an xml file each time i start based on certain comments added to controller classes. This xml file contains the api’s documentation.
I think that same code also gives you a swagger/index.html website which provides a page showing documentation on using the interface.
the website gives links on executing those APIs as well. I think this is configurable so that you and turn on and off certain types. It’s similar to postman, however it’s a different interface but shows hints based on the documention you added.
another nugget package, and a bit of coding to the startup routine, and the compiler will provide warnings for each method / function that isn’t documented.