Add SOAP documentation from a WSDL file

This page guides you through the steps necessary to generate SOAP documentation from a WSDL in your project.

Before you begin

Make sure you have the following before you begin:

a redocly.yaml file in the root of your project
the Redocly package for the product you use (such as @redocly/realm) as a dependency in package.json

Local dependencies required

Redocly projects can be previewed locally without installing the dependencies but to add the SOAP plugin it is required to have both Realm and the SOAP plugin installed as local dependencies.

If you see the error Theme "@redocly/portal-plugin-soap-api" not found, then check that you have the @redocly/realm package listed in package.json.

Install plugin

Install SOAP plugin with your package manager:

npm

npm install @redocly/portal-plugin-soap-api

yarn

yarn add @redocly/portal-plugin-soap-api

pnpm

pnpm add @redocly/portal-plugin-soap-api

Enable plugin in redocly.yaml

Enable the SOAP plugin in your project.

plugins:
  - '@redocly/portal-plugin-soap-api/plugin.js'

For more information about this plugin, see SOAP plugin reference.

Add a WSDL file to your project

Place your WSDL file into your project in the desired directory.

You can use this WSDL example to test out the feature if you don't have a WSDL file to use. Copy the example to <filename>.wsdl file in your project.

Start the project

Run the project with the following command:

npx @redocly/cli preview

Once the server has started, navigate to the WSDL location to see the documentation for the SOAP API.

Resources

SOAP plugin