Last updated January 17, 2020
Module Development8.9.x/9.0.x

It is important to have good up-to-date documentation about your web services. Doing so will boost developer productivity in a decoupled project. Drupal offers several tools that help maintain your API documentation with minimal effort.

In this tutorial we'll:

  • Learn about the JSON schema format for describing data structures
  • Generate schemas for our fake articles REST resource
  • Visualize those schemas in a human-readable format

By the end of this tutorial you should be able to generate documentation for your REST resources that is kept up-to-date automatically by Drupal.