Check your version

This video covers a topic in Drupal 7 which may or may not be the version you're using. We're keeping this tutorial online as a courtesy to users of Drupal 7, but we consider it archived.

Alternate resources: 

Documenting Your API

Video loading...

Transcript language code: 

Join Drupalize.Me to watch this video

Join today and gain instant access to our entire video library.

Log in Sign up
  • 0:00
    Building Web Services with Drupal 7 Documenting
  • 0:03
    Your API with Joe Shindelar
  • 0:08
    An API is only as good as its documentation.
  • 0:10
    Without it, there's no way for me as an external developer to even know
  • 0:14
    what resources I can request or what URIs I should be using.
  • 0:18
    There's nothing more frustrating than poorly documented APIs.
  • 0:22
    If I don't have access to your code and there's no documentation,
  • 0:25
    I'm shooting in the dark when it comes
  • 0:27
    to trying to make use of your API.
  • 0:29
    And if I can't use it, does it even exist?

Documenting Your API


An API that exposes data and actions to a 3rd party is only as good as the documentation for that API. Without good documentation no one will be able to make use of the API you just spent so much energy creating. In this lesson Joe shows some of his favorite API documentation examples and then walks through creating some basic documentation for the resource we created in the previous lesson.

Log in or sign up to download companion files.
Additional resources: 

Example - GitHub API Documentation

Example - Recurly Documentation - tool to assit in writing good documentation