Compare commits

...

6 Commits

Author SHA1 Message Date
Robert Wallach
e77a4cc420 Update reference-spec.md 2018-03-16 12:22:19 -05:00
Robert Wallach
901da1746a Update reference-spec.md 2018-03-14 13:19:03 -05:00
Nicholas Cassera
3baf13bdd4 version 2 2018-03-01 16:00:51 -06:00
Nicholas Cassera
045f87466d referencing another specification article 2018-03-01 15:04:52 -06:00
Nicholas Cassera
4f1c9fdeee develop -> branch 2018-03-01 14:48:55 -06:00
Nicholas Cassera
68e7016ce2 reference-spec initial 2018-02-05 17:19:44 -06:00

View File

@@ -1 +1,43 @@
# Referencing Another API Specification
<!-- REFBUILDER GIF/VIDEO-->
## 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
1. Choose the **source**
* This File
* This Project
* Select a **file**
* Shared/Common
* External URL
* Enter a valid **URL** to an existing specification
2. Select a **target**, if required
3. Confirm your choice. (Only required if there is a confirm button)
4. View the referenced specification by clicking the book icon
---
**Related Links**
* [Reference other Sources](../hubs/ref-other-sources-hubs.md)
* [Creating Models](../modeling/how-to-create-models.md#How-to-Create-Models-using-the-Stoplight-Modeling-Editor)
* [Shared Parameters and Responses](../modeling/shared-params-responses.md)
* [Contract Testing](../testing/contract-testing.md#connecting-the-spec)
* [Setting Up a Prism Mock Server](../prism/mocking.md)