Devportal module package (8.x-1.0)

The Devportal module is a package that contains 4 submodules:

• Devportal (main module)
• Devportal API Reference (submodule)
• Migrate Batch (submodule)
• Repository Sync (submodule)
• API entities (submodule)

All of them provide specific functionalities discussed below.

Devportal (main module)

The Devportal module is a wrapper that contains the 4 submodules that have further functionalities. After enabling the main module, it creates a new administrative menu item called Devportal. It is located between Configuration and People.

Devportal API Reference (submodule)

Contrib module requirements: Devportal, Migrate Batch, Swagger UI Field Formatter

The Devportal API Reference module provides the API reference entity. It has two main functions:

• JSON file/Swagger spec. validation
• Reference file revision

JSON file/Swagger spec. validation

With the Devportal API Reference submodule, you can upload OpenAPI 2.0 (Swagger) files to your developer portal. The module checks and validates the uploaded JSON files to make sure that they are valid and their syntax corresponds with the Swagger specification.

If the uploaded file is valid, then the API reference page will be created from the Swagger file. If the uploaded file is invalid, then an error message informs the user about the failed validation, for example:

The JSON source file (name_of_the_file.json) cannot be decoded or the encoded data is deeper than the recursion limit (512).

Reference file revision

When you upload a valid API reference file, an API reference node is created. The module automatically pulls the title, the description and the version number of the API from the uploaded Swagger file and displays them on the node. You don’t need to add this information manually, although you can edit the imported values via the administrative UI.

Migrate Batch (submodule)

Contrib module requirements: Devportal

The Migrate Batch submodule provides a progress bar that visualizes the repository import process.

Repository Sync (submodule)

Contrib module requirements: Migrate Batch, Devportal API Reference, Devportal, Swagger UI Field Formatter

The repository sync submodule allows importing any public repository from GitHub to your developer portal. (See Importing a repository).

API entities (submodule)

Module requirements: Entity Reference, Revisions, Inline Entity Form, Migrate Plus, Migrate Batch, Devportal API Reference, Devportal, Swagger UI Field Formatter

The API entities submodule creates Drupal entities from different parts of the imported Swagger file. This submodule won’t be part of the 2.x version of the module.