4

I have no experience writing API documentation, but a need has arisen for it at my company. However, the only guides I can find for API Documentation are for APIs that use JSON, XML, Java, etc. What is the best way to dive into API documentation using a C# document as a first project?

4

Look at API documentation for C#, such as that on the Microsoft site (see here), or check out one of the multitude of repositories on Github.

Basically, API document the ways users interact with your product. You have to specify fields, classes, methods, constants, etc. Look at the Java API to see a systematic way to do this and then adapt it to your product.

| improve this answer | |
  • Thank you! This is great. The Microsoft site is a great resource, especially as I'm looking for the differences between documenting something like Java and documenting C#. – Calley Jan 5 '16 at 21:18
3

If the API you're going to document is a REST API, Tom Johnson has this excellent free online course, Documenting REST APIs.

If that doesn't fit your needs, Stack Overflow has a couple of topics that might also be interesting:

An important API doc tool that's trending right now is the Swagger Editor, which includes support for C#. For a great example of API doc, check out the Swagger examples.

| improve this answer | |

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.