Annotating API responses

The smartAPI profiler, is a service which gets your web service signature to automatically annotate if a matching resource is found in Identifiers.org, otherwise possible matches based on comparing a sample value for that keypaths with regex patterns are suggested. If no match, you are able to enter your own resource name or select from list of all resources from Identifiers.org in dropdown. You can also get more details about the selected resource by clicking the info icon.

We have integrated the profiler within the editor, to annotate the operation response data.

Add responseDataType meta-data under the response. Press Ctrl-Spcace, then release and hit return. The profiler opens in the right panel. Review the automatic annotations and add manual annotations (if needed) and click the submit button.

The annotated data is added to the editor as the value of the responseDataType