Some good practical hints here about making your API more usable through the way you document it.
Bookmark of 'Writing better API documentation: a few lessons from enterprise integration'
Writing better API documentation: a few lessons from enterprise integration Over many years working on API integrations, I’ve seen a whole lot of ways that the experience could be less frustrating. This isn’t a definitive list but a personal collection of a few recurring problems with documentation I’ve seen in different REST APIs that could be avoided. Explain what a field does Consider API documentation like this: String[] tags - “This field contains tags for the post.” This is not helpful. (published )
