Getting Started with SOAP-2-REST

A guide for new users to get started with the SOAP-2-REST platform, covering core concepts, system requirements, and a quickstart tutorial.

Applies to1.7.1

Overview

This guide provides a structured path for new users to understand and operate the SOAP-2-REST platform. It serves as the primary entry point to the knowledge base, directing you to essential documentation for a successful first experience.

The platform is currently at v1.0 (General Availability).

The recommended path involves reading the documentation in the suggested order to build a foundational understanding of the platform's model, vocabulary, and requirements before attempting to publish a service.

Suggested Reading Order

For users new to the platform, follow these documents in sequence to progress from core concepts to a running service.

  1. Introduction Understand what SOAP-2-REST is, its Publish/Consume model, its position in a technical stack, and its intended users.

  2. Core concepts Learn the essential vocabulary used throughout the platform and documentation. This includes terms such as service, operation, mapping, mapping version, Publish vs Consume, discovery, learned example, connector, conversion option, correlation ID, contract drift, RBAC roles, and environment.

  3. System requirements Confirm that your target host meets the necessary prerequisites for deployment, including PostgreSQL version, container runtime, JVM, network egress for licensing, and payload limits.

  4. Quickstart Follow the fastest path to a running service. This guide covers standing up the standalone Docker Compose stack, importing a WSDL, configuring a backend, reviewing the generated OpenAPI v3 specification, publishing the service, and making a test call.

Next Steps

Once you have completed the quickstart and are familiar with the basic workflow, proceed to the following sections for more advanced topics:

  • Installation: Guides for production deployments on GCP, Kubernetes/OpenShift (via Helm), and Docker Compose.
  • Onboarding a service: A comprehensive walkthrough of the WSDL-to-publish workflow, detailing all available options.
  • Discovery & connectors: Instructions for enabling traffic-driven discovery of services.
  • Support: Information on available support tiers and how to get help.

Documentation Conventions

The following conventions are used throughout the knowledge base:

  • Error Codes: All error codes follow the format S2R-RUN-0413, which includes a service prefix and a numeric code.
  • Database Tables: All platform database tables are prefixed with s2r_.
  • Java Packages: The root Java package is com.specaria.s2r.
  • Placeholders: User-specific values like hostnames, project IDs, or group names are represented in <angle-brackets>.
  • Feature Versioning: A Since v1.0 note indicates when a specific capability was first introduced.

See Also

Tagsguides

All SOAP-to-REST docs