Getting Started with the SOAP-2-REST Platform

A guide to getting started with the SOAP-2-REST platform, from core concepts and system requirements to a quickstart for publishing your first service.

Applies to1.xFrom 1.7.30

Overview

This guide provides an orientation to the SOAP-2-REST platform and a structured path for new users to get a service running. It covers the foundational concepts, system prerequisites, and includes a quickstart tutorial for a hands-on experience.

The current release is v1.0 (General Availability).

In This Section

The getting started documentation is divided into the following articles:

  • Introduction: Explains what the SOAP-2-REST platform is, the Publish/Consume model it uses, where it fits within a technology stack, and its intended users.
  • Core Concepts: Defines key terminology used throughout the platform and its user interface, such as service, operation, mapping, connector, and environment. Understanding these concepts is recommended before proceeding to the quickstart.
  • Quickstart: Provides the fastest path from initial setup to a published service. This guide walks through standing up the standalone Docker Compose stack, importing a WSDL, configuring a backend, reviewing the generated OpenAPI v3 contract, and making a test call.
  • System Requirements: Details the prerequisites for deploying the platform. This includes supported PostgreSQL versions, container runtimes, JVM requirements, network egress rules for licensing, payload size limits, and capacity baselines.

Suggested Reading Order

For users new to the platform, the following reading order is recommended:

  1. Introduction: Understand the platform's purpose and operational model.
  2. Core Concepts: Learn the vocabulary used in the product and documentation.
  3. System Requirements: Confirm that your target deployment environment is supported.
  4. Quickstart: Deploy the platform and publish your first service.

Next Steps

After you have completed the getting started guides, you can explore more advanced topics:

  • Installation: Find detailed guides for deploying the platform to production targets, including GCP, Kubernetes/OpenShift (via Helm), and Docker Compose.
  • Onboarding a Service: Learn the complete workflow for publishing a service from a WSDL, including all available configuration options.
  • Discovery & Connectors: See how to enable and configure traffic-driven discovery of services.
  • Support: Review available support tiers and learn how to get help.

Documentation Conventions

The following conventions are used throughout this documentation:

  • Error Codes: All error codes follow the format S2R-RUN-0413, which includes a service prefix and a numeric code. A complete list is available in the error codes reference.
  • Database Tables: All database tables created and managed by the platform are prefixed with s2r_.
  • Java Packages: The root Java package is com.specaria.s2r.
  • Placeholders: Customer-specific values, such as hostnames or project IDs, are shown in <angle-brackets>.
  • Feature Versioning: A Since v1.0 note indicates when a specific capability first became available.
Tagsguides

All SOAP-to-REST docs