Articles/modeling/reference spec (#154)
* reference-spec initial * referencing another specification article * version 2 * Update reference-spec.md * Update reference-spec.md
This commit is contained in:
committed by
Robert Wallach
parent
11468e8f89
commit
a45948bb33
@@ -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)
|
||||
|
||||
Reference in New Issue
Block a user