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
- De-duplicate 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