Tag Info

About

API design (choosing which information to expose and the format it takes) is a well-trodden topic with lots of great resources available for reference.

API documentation needs to be simultaneously technically complete and explicit while being human-readable and meaningful. It should take into account realistic design requirements as well as providing things like example usage and sample code.

Questions with this tag should be about either designing an API itself or about documenting it effectively.

Additional resources:

history | show excerpt | excerpt history