Skip to main content
drupalreleases

Use direct release data with your AI assistant.

Learn more

API Docs

Security covered Under active development 8 sites

Part of the API ecosystem · 22 projects

This module allows you to create and display API documentation within your Drupal site. It provides a content type for defining API documents and field formatters to render them using Redoc or Swagger UI. A view is also included to list published API documentation.

This module will provides API Docs to your Developer Portal, It is powered by Drupal content type, custom field formatters & views.

Features covered

  • API Docs module will provide API Docs Content type, Redoc & Swagger UI Field Formatters & API Docs View.
  • Admins can create API Docs with the help of API Docs content type, by filling out the API Doc Name, Description, Status & Open API Spec.
  • Users can see the List the published API Docs with the help of API Docs View.

Installation

Configuration

  • After enabling the module, navigate to Add API Docs /node/add/api_docs.
    • Fill the API Doc Name, Description, Status & Open API Specification, Save the content by clicking Save.
    • Similarly, Admin will be able to create as many API Docs.
  • Navigate to API Docs via /api-docs.
    • Users can see list of API Docs published in the site, with filter by API Doc Status, with minimal details of the API Doc.
    • Each API Doc in this list will have View Redoc UI & View Swagger UI, users will be able to navigate to respective API Doc pages.

Customizations

  • API Docs is providing a Field Formatter, Open API Field Formatter.
    • Open API field formatter can be used in for any file field type within your site
    • Open API field formatter, can render the file in two possible ways
      • One with Redoc UI format.
      • Other with Swagger UI format.
    • Admin will have the flexibility to change this configuration of the Open API field formatter.
  • API Docs is providing two View modes, they are Redoc UI & Swagger UI, these View modes are used in the API Docs content typs displays & API Docs View. If needed these can be customized at API Docs display level.
Drupal 8–10 · not 11

Ask your assistant about API Docs

Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works

Depends on

Dependencies of the latest stable release

No dependencies recorded for this project.

Required by

Tracked projects that depend on this one

No tracked projects depend on this one yet.

Activity

Tracked releases
4
Tracked since
Jul 2023
Latest release
3 years ago
Releases (12 mo)
0
Maintenance
Dormant

Release Timeline

Releases

Version Type Core PHP Release date
2.0.x-dev Dev 8–10 Jul 31, 2023
2.0.1 Stable 8–10 Jul 28, 2023
2.0.0 Stable 8–10 Jul 28, 2023
2.0.0-beta2 Pre-release 8–10 Jul 20, 2023