About API Fragments

Requires November 2017 Release

An API fragment is a RAML document that has a version and an identifier, but is not in itself a complete RAML specification. An API fragment is one of the following types defined by

  • Trait

  • Resource Type

  • Library

  • Type

  • User Documentation

  • Example

  • Annotation Type

  • Security Scheme

You can publish an API fragment to Exchange, include fragments as dependencies in a project, and revise a fragment. After revising a fragment, update API specifications that use the fragment to include the new version.

To make any an API specification or fragment available for use by others, you need to publish the design to Exchange.

In this topic: