REST API documentation - Swagger/OpenAPI

Sterling™ Order Management System provides comprehensive REST API documentation by using the OpenAPI 3.0 standard, formerly known as Swagger. This documentation system offers complete API reference, interactive testing, structured schemas, search capabilities, and a user-friendly interface.

Overview

The Swagger/OpenAPI documentation system offers the following features:

  • Complete API reference: Detailed information about every REST API endpoint that is available in Sterling Order Management System.
  • Structured schemas: Clear definitions of request and response data structures.
  • Search capabilities: Quickly find APIs across all modules.
  • User-friendly interface: Easy-to-navigate HTML documentation.

Benefits

The Swagger/OpenAPI documentation provides the following key benefits:

  • Faster integration: Developers can quickly understand and integrate with Sterling Order Management System APIs.
  • Self-service: Explore and test APIs without contacting support.
  • Accurate information: Auto-generated from source code, ensuring accuracy.
  • Standards-based: Compatible with popular API tools such as Postman and Insomnia.
  • Always current: Updated with each Sterling Order Management System release.

Getting started

To begin using the Swagger/OpenAPI documentation, complete the following steps:

  1. Generate the documentation by using the provided commands.
  2. Explore the key features that are available in the documentation.
  3. Understand the documentation structure and organization.
  4. Access the interactive HTML documentation or JSON specifications.