I'm working with a few developers on a hobby project and we have a lot of different APIs. What are some popular methods of creating documentation on the potential requests, and what can be expected to be returned? Is there any fancy automatic generation tools for this?
\$\begingroup\$
\$\endgroup\$
asked Jul 29, 2013 at 15:28
Add a comment
|
1 Answer
\$\begingroup\$
\$\endgroup\$
Take a look at how RFCs are done. Here's one for the client-side IRC protocol.
There is no set standard but Backus-Naur form (and extensions) are widely used. The upside of using BNF is that there exist tools that will output the code that obeys the protocol.
This means that instead of doing Manual C# => Autogenerated Document protocol, you could do Manual Document Protocol => Autogenerated C# code.
