TerribleDev/docs

Files

Nicholas Cassera a45948bb33 Articles/modeling/reference spec (#154 )

* reference-spec initial

* referencing another specification article

* version 2

* Update reference-spec.md

* Update reference-spec.md

2018-03-16 12:22:42 -05:00

1.2 KiB

Raw Blame History

Referencing Another API Specification

What

Referencing another specification allows for cleaner and more organized code. Some use cases are as follows:

Generate API documentaion in Hubs
Deduplicate common structures like responses or shared parameters in Modeling
Test a connected API specification in Scenarios
Setup a mock server for an API in Prism

How

Choose the source
- This File
- This Project
  - Select a file
- Shared/Common
- External URL
  - Enter a valid URL to an existing specification
Select a target, if required
Confirm your choice. (Only required if there is a confirm button)
View the referenced specification by clicking the book icon

Related Links