SWIM Supporting Material

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Page Table of Content

Version

This page concerns v2.0 of the Specification. Supporting material on v1.0 is <tbd>

Requirement

Title

Machine-readable service interface definition

Identifier

SWIM-SERV-320

Requirement

If the service interface binding specifies the use of machine-readable formats, a service description shall include or refer to a service interface definition in a machine-readable format using a standard service definition formalism/language.

Rationale

Enables consumer software components to be created.

Verification

Completeness: If the service interface binding supports it, verify that the required elements are included.

Consistency: Verify that provided elements are consistent with the selected binding.

Correctness: Not Applicable.

Examples/Notes

Example machine-readable descriptions:

  • service descriptions:
    • WSDL (e.g. if a Web Service binding using SOAP is selected);
  • message descriptions:
    • XSD;
    • Schematron Rules.

Note: AMQP does not mandate a specific machine-readable format.

Note: REST may use OpenAPI, WSDL 2.0 or WADL.

Level of Implementation

Mandatory (Conditional)

Guidance

tbd

Example

Machine-readable service interface definitionService description in WSDL 1.1 <<add reference>>

Message description by XML Schema  <<add reference>>



  • No labels