HTTP Requests from OpenAPI
You can use an OpenAPI Document to interact with the HTTP REST API of RaptorXML+XBRL Server. This can be useful not only for discovering and understanding the features of the HTTP REST API, but also to test specific HTTP requests before generating code that implements these requests.
Your installation of RaptorXML+XBRL Server contains an OpenAPI Document file in YAML format, which you can try out or extend. This file is located in the Examples folder of your RaptorXML+XBRL Server installation. On Windows, the file location is: C:\Program Files\Altova\RaptorXMLXBRLServer2027\examples\raptorxbrl_http_rest_api.yaml. On Linux, go to the RaptorXML+XBRL Server Examples folder.
You can easily send an HTTP request from an OpenAPI file in the following interactive ways:
•Open the file in Altova XMLSpy and send the request from the relevant location in the file via a context menu command. See HTTP Requests via Altova XMLSpy.
•Open the file in Swagger Editor and send the request via the editor's interface. See HTTP Requests via Swagger Editor.
The mechanism for sending requests to RaptorXML+XBRL Server's HTTP API and receiving responses is described in the section Client Requests.