CDISC has developed a rich set of programmatic interfaces for accessing CDISC standards and their metadata through REST API implementation. Technical details can be found in our API Documentation where users can view specifications, examples, and schemas for each API endpoint.
This article highlights a feature in the API Documentation, called API mocking. Simply, users can try out each of the API endpoint to see how a request can be made, submit it, and see a mocked response returned. This is especially useful for prospective customers, wanting to know more about how it works before making a commitment.
Step-by-step guide
Ensure the server option Swagger API Auto Mocking is selected when trying out an endpoint.
Step | Instruction | Notes |
---|---|---|
1 | Go to the CDISC Library API Documentation web page: https://www.cdisc.org/cdisc-library/api-documentation. |
|
2 | Select the entry that corresponds to SwaggerHub API Auto Mocking from the Servers drop down box. |
|
3 | Click on an endpoint to expand for Parameters and Responses. |
|
4 | Scroll down to the Parameters section, where a button labeled Try it out appears. | |
5 | Click the Try it out button. The button text will become Cancel. Another button labeled Execute will appear immediate below. | |
6 | Click the Execute button. The Responses section will be refreshed with a curl command, requested URL, and the mocked server response. |
|
7 | OPTIONAL Where parameters are available for any given API endpoints, update the pre-populated values and re-execute. |
|