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 »

Requirement

Title

Machine-readable service interface definition

Identifier

SWIM-DEFN-320

Requirement

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

Rationale

The machine-readable format 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:

  • title: Interface WSDL

  • description: Machine processable description of the service
    interface

  • reference: public:/2019-09/TOBT_Interface.wsdl

Other examples include the use of the OpenAPI Specification that standardises how HTTP APIs are described.

Level of
Implementation

Recommended - Conditional

Guidance

Verification Support

Examples

  • No labels