Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
This project is not covered by Drupal’s security advisory policy.
Update
Open API is most likely to be the preferred option for human-readable API docs moving forward. You should consider using that module over this one when evaluating your needs.
Overview
The self documenting REST API module provides automatic API documentation for your REST API.
Whilst building your site, be sure to complete help documentation for each field as you add them to your entities.
This module will then introspect the available REST routes as well as views that contain REST Export displays and automatically build API documentation pages for your REST API.
Features
- List of endpoints.
- Required fields and values.
- Configure the end-points listed.
- Provide an overview of API.
- Auto-parses doc-block summary for controller methods.
Requirements
Be sure to add help documentation for each field as you add it to your entity, the module uses those values to document the format and example values for each field.
Roadmap
See the Roadmap tag for issues on road-map prior to a 1.0 release.
Known problems
None, please use the issue queue to report and problems experienced.
Last updated for Core against commit 2c6cd92 - September 25th
Tutorials
Coming soon.
Credits
Written by Lee Rowlands for an article in Drupal Watchdog.
Recommended modules
Use the REST UI module for simple point and click configuration of your REST API end-points.
Similar projects
Inspired by the Symfony NelmioApiDocBundle which provides similar functionality for Symfony based REST APIs.
Supporting organizations:
Maintenance
Project information
Unsupported
Not supported (i.e. abandoned), and no longer being developed. Learn more about dealing with unsupported (abandoned) projects- Obsolete
Use of this project is deprecated. - Module categories: Developer Tools, Site Structure, Import and Export
47 sites report using this module- Created by larowlan on , updated
This project is not covered by the security advisory policy.
Use at your own risk! It may have publicly disclosed vulnerabilities.
