• Increase font size
  • Default font size
  • Decrease font size

Web API Documentation

by martin on September 30th, 2010

Peter Gruenbaum wrote a great article on best practices for producing documentation for Web-based APIs. He notes the importance of auto-generating API documentation, including sample code, showing example requests and responses, and explaining authentication and error handling.

From → Documentation

Comments are closed.

ABOUT THIS SITE

An Application Programming Interface (API) provides a logical interface to a piece of software and hides its internal details. This website is dedicated to a book on designing APIs for C++ and includes articles and links on API development.
 

SOURCE CODE

The book is accompanied by a source code package that contains many of the examples in the text. Download it for free.
 

OTHER BOOKS

Dr. Reddy has also published a computer graphics book called Level of Detail for 3D Graphics. Check it out too!.
 
Copyright (c) 2014 Martin Reddy. All rights reserved. Login