Getting Started Overview

This documentation section provides the foundational knowledge required to understand and begin using the SOAP-2-REST platform. It is designed for new users and should be read in the suggested order to build a comprehensive understanding.

The articles in this section introduce the platform's core Publish/Consume model, define key terminology used in the user interface and API, detail system prerequisites, and guide you through publishing your first service. The current release of the platform is v1.0 (General Availability).

Suggested Learning Path

For the most effective onboarding experience, follow the documents in this prescribed order. This path ensures you understand the conceptual model and vocabulary before proceeding to the hands-on tutorial.

flowchart TD
    A["1. Introduction"] --> B["2. Core Concepts"];
    B --> C["3. System Requirements"];
    C --> D["4. Quickstart"];

1. Introduction: Understand the Publish/Consume model, where the platform fits within a typical system architecture, and its intended users.
2. Core Concepts: Learn the essential vocabulary, including terms like service, operation, mapping, connector, and environment. This is critical for understanding the user interface and subsequent documentation.
3. System Requirements: Confirm that your target deployment environment meets the necessary prerequisites for installation and operation.
4. Quickstart: Follow a step-by-step guide to deploy the standalone stack, import a WSDL, publish a service, and make a test call.

In This Section

This section contains the following articles:

• Introduction Explains what the SOAP-2-REST platform is, its Publish/Consume model, its position in a technical stack, and its intended audience.

• Core Concepts Defines the vocabulary used throughout the platform and its documentation. Key terms include: service, operation, mapping, mapping version, Publish vs Consume, discovery, learned example, connector, conversion option, correlation ID, contract drift, RBAC roles, and environment.

• Quickstart Provides the fastest path to a running service. The guide covers standing up the standalone Docker Compose stack, importing a WSDL file, configuring the backend service, reviewing the generated OpenAPI v3 specification, publishing the service, and executing a test call.

• System Requirements Lists the technical requirements for deploying and running the platform. This includes details on PostgreSQL, container runtimes, JVM, supported deployment targets, network egress for licensing, payload size limits, and capacity baselines.

Documentation Conventions

The following conventions are used throughout the knowledge base:

• Error Codes: Errors are identified by a structured code, such as S2R-RUN-0413, which consists of a service prefix and a numeric identifier.
• Database Tables: All platform database tables use the s2r_ prefix.
• Java Packages: The root Java package is com.specaria.s2r.
• Placeholders: Customer-specific values like hostnames or project IDs are shown in <angle-brackets>.
• Feature Versioning: A Since v1.0 note indicates when a specific capability was introduced.

Next Steps

After you have completed the Getting Started guides, you can explore more advanced topics:

• Installation: Instructions for production deployments using GCP, Kubernetes/OpenShift Helm charts, or Docker Compose.
• Onboarding a Service: A comprehensive guide to the WSDL-to-publish workflow, covering all available options.
• Discovery & Connectors: Information on configuring traffic-driven service discovery.
• Support: Details on how to obtain help and an explanation of support tiers.

See Also

• Release Notes for v1.0
• Error Code Reference

All SOAP-to-REST docs