Skip to content

0504 Implementation Snippets

Developers can be aided in their work by having snippets of schema implementation that follow approved structures and naming conventions that they can include in their APIs and data structures.

UML

ImplementationSnippet entity

The ImplementationSnippet entity is for the storage of an implementation snippet, along with details of its language and version. It inherits from Referenceable which means it can have a link to an external reference which could be, say, a physical schema implementation in a source code repository).

The additional attributes of an implementation snippet are:

  • snippet - the implementation code.
  • implementationLanguage - the programming/encoding language used for the snippet. For example, JSON, XML, Java, ...
  • usage - how should this snippet be used.

The snippet is linked to the element it represents using the ImplementedBy relationship.

Raise an issue or comment below