Glossary · Automation software engineering and architecture
Service interface
Also known as: Service contract, Service API
German: Dienstschnittstelle
In service-oriented software, a service interface is the published description of the operations, messages and data formats through which a service can be used, independent of its internal implementation.
- Software engineering
In one sentence
A service interface publishes the operations, messages and data formats through which a service can be used, independent of its implementation.
Example
The order management service offers a REST service interface with operations to create, release and cancel production orders, described in an OpenAPI document.
How it applies
- Engineering: Service interfaces are described in machine-readable form, such as OpenAPI, gRPC definitions or OPC UA information models, which enables code generation and automated tests.
- Change control: Consumers depend on the interface, not the implementation. Interface changes need versioning, deprecation periods and communication to consumers.
- Documentation: Generated reference documentation covers the syntax; the documentation team adds concepts, workflows, error handling and examples. Keep the reference generated from the same definition the service uses.
Service interface vs. component interface
A Component interface can be a local programming interface within one application. A service interface is usually accessed over a network and designed for independent consumers.