TerribleDev/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

referencing another specification article

Browse Source
This commit is contained in:
Nicholas Cassera
2018-03-01 15:04:52 -06:00
parent 4f1c9fdeee
commit 045f87466d
1 changed files with 18 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
articles/modeling/reference-spec.md
View File

@@ -1,48 +1,44 @@
# Referencing another API Specification
<!-- ![image]() -->
<!-- REFBUILDER GIF/VIDEO-->
## What
Depending on your use case, you may find yourself needing to reference or connect to another spec. You have the ability to easily connect to another specification in your project, one that has been publicly shared, one from an external source, and even reference certain targets within your current specification. You can reference either the entire specification or target a specific section if applicable. This can be used to generate documentaion in hubs, deduplicate common structures in modeling, test a connected specification in scenarios, or setting up a mock server for an API.
Depending on your use case, you may find yourself needing to reference or connect to another spec or part of your current one.
This can be done easily for another specification in your project, one that has been publicly shared, one from an external source, or even reference certain targets within your current specification.
Reasons for referencing another specification include generating documentaion in hubs from an oas file, deduplicating common structures in modeling, testing a connected specification in scenarios, or setting up a mock server for an API.
## How
* Choose the appropriate data source.
1. Choose the appropriate data source.
* This File
* This File
* This Project
* This Project
* Select a file.
* Shared/Common
* Shared/Common
* External URL
* External URL
* Enter a valid url that contains data for an existing specification.
2. Select a file or enter a valid url that contains data for an existing specification.
* Select a target, if required or applicable.
3. Select a target, if required or applicable.
* Confirm your choice, if you see a confirm button.
4. Confirm your choice, if you see a confirm button.
* View the referenced specification by clicking the book icon.
5. View the referenced specification by clicking the book icon.
## Where
* Documentation
* [Reference other Sources](../hubs/ref-other-sources-hubs.md)
* Modeling
* [Creating Models](../modeling/how-to-create-models.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)
* Testing
* [Insert related testing doc here](../testing/some-doc.md)
* [Contract Testing](../testing/contract-testing.md#connecting-the-spec)
* Mocking
* [Setting Up a Prism Mock Server](../mocking.md)
* [Setting Up a Prism Mock Server](../prism/mocking.md)