Any HTTP request in an application is represented as a set of lines, each line contains some field. +Each field contains a separate part of the HTTP request, such as a URL address, method, header, parameter, etc. +There can be only one selected field, and it is highlighted with a colored frame.
+url https://github.com/ in the one existing field.Ctrl-Enter(Cmd-Enter on macOS).method GETCtrl-Z or F5.F11.Status, Response Time and Response Size, headers and body of the response if it was received from the server.Most used shortcuts:
+F1 or Ctrl-H - If you forgot a shortcut, you can check it at any time in the popup-help. It contains search by name or keyboard shortcut.Ctrl-Enter - Adding a new empty field below the selected field.Alt-Enter - Adding a new empty field on top of the selected field.Shift-Enter - Adding a new empty field at the end of the fields.F11 - Switching between tabs for HTTP request fields and Result.Ctrl-Z or F5 - Run HTTP requestCtrl-B or F4 - Cancel an HTTP request if it is not completedYou can check the full documentation about all fields at this link
+ + + + + + +Fields marked [single] must only be specified once in the request. If you specify them several times, the value will be taken from the last line in order.
+url X [single]Specifies URL for the HTTP request, where X it full URL.
+Example: url https://github.com
method X [single]Specifies the HTTP request method. Where X can be one of the possible values: GET, POST, PUT, DELETE, PATCH.
+Example: method POST
body X [single]Specify the content in the body for the HTTP request.
+Example: body {"jsonField": "jsonValue" }
form X=YAdd form field where X it name of field and Y it value.
+Example: form count=100
file X=YAdd file field where X it name of file field and Y it full path for file in filesystem.
+Example: file poster=~/images/poster.jpg
<header name> <value>Add header field for one of standart headers, where header name it name of standart header and value it header value.
+You can see full list of standard headers on this page.
Example: Content-Type application/json
X-<header name> <value>Add header field for non standart headers, where header name it name of header and value it header value.
+For a while there was a format for custom headers like X-<Header Name>.
Example: X-USERID 550
header <header name> <value>Add header field for non standart headers, where header name it name of header and value it header value.
+Example: header USERID 550
pastry <cookie name>=<value>Adding parameter to Cookie header, where cookie name it name of header and value it value.
Example: header USERID 550
protocol <value>By default, all HTTPS requests will attempt to use the HTTP/2 protocol. If this is undesirable behavior, you can force requests to run over HTTP/1.1 defining this field.
+Example: protocol 1.1
param <parameter name>=<value>Adding a URL parameter, where parameter name is the name of the parameter and value is its value.
+For ease of readability, it may be helpful if the URL itself and its parameters are separated. For example, I have a full URL http://test.com?id=20.
+We can split it in the application into two lines: the first url http://test.com and the second param id=20.
Example: param userId=1
route <route name>=<value>Adding a URL parameter, where route name is the name of the parameter and value is its value.
+The modern way is to add URL parameters as part of the route, like http://test.com/products/20/product, where 20 is actually an parameter like identifier.
+We can split it in the application into two lines: the first url http://test.com/products/{id}/product and the second route id=20.
+The application supports placing the same segment in multiple places, for example http://test.com/products/{id}/product/{id}.
Example: route segment=2
postscript <script>Adding a postscript, where script is a script written in JavaScript to process the request result.
+The script can be used to validate results using custom logic. You can read more about scripting on this page.
Example: postscript result.hasErrors = response.statusCode != 200;
title <name>Adding title for query, where name is the name of the query.
+The title will appear in the request list and can be used as a human-readable description.
Example: title Query for get all products
options <option1>,<option2>,<option3>Adding options for performing query, where optionX is the name of the option.
+You can check the list of all options on this page.
Example: options noautoredirect,weaksslcheck
An alias combines multiple fields into a single field.
+bearer <token>Added authorization header with bearer type and value from token.
Example:
+bearer ABCDEF -> Authorization Bearer ABCDEF
json <content>where content it body content. This can be useful if you are making a request to a restful API.
Example:
+json {"result": true}
+->
+Content-Type application/json
+Accept application/json
+body {"result": true}
xmla <content>where content it body content. This can be useful if you are making a request to a restful API.
Example:
+xmla <xml></xml>
+->
+Content-Type application/xml
+Accept application/xml
+body <xml></xml>
You can define a global variable and use it in your queries. To open the Global Variables window, press Ctrl-F6/Command-F6.
+The format of a global variable is the same as in the <variable name> <value> query editor.
+You can press Ctrl-Enter to add a new line for create a new global variable.
+At the end of edit session you need to save the global variables by pressing Ctrl-S/Command-S.
+After this you can use the global variable in your queries like {{<name of variable>}}.
As example global variable mytoken 4354534534534534534
bearer {{mytoken}}
+header will be replaced on bearer 4354534534534534534.
Cross-platform desktop is a tool for making HTTP(S) requests from websites or RESTful APIs. Similar to cURL, but with a graphical interface.
+Can be used for testing and/or developing web applications. Application have minimal user interface and keyboard oriented.
+The HTTP request is broken down into a human-readable set of lines. Each line describes the type at the beginning, for example url means we define the URL for the HTTP request.
+Each type of line has a different color to help visually identify that content.
You can always download the latest stable version from this link.
+If you find a bug or have suggestions for the application, feel free to post an issue or discussion in the repository.
+ + + + + + +Options are written as a set of words separated by a comma (option 1, option 2).
+Example: options noautoredirect,noweaksslcheck.
Default behaviour is auto redirect if server responsed any from 30x HTTP codes.
+noautoredirect - If the endpoint tries to redirect, this will not happen. In response, you will see information about the redirect.autoredirect - If the endpoint tries to redirect, this will happen without any limitation. The only exception is a redirect between https to http which is not allowed.autoredirectsameorigin - If the endpoint tries to redirect, this will happen only if it happened on same host, port and protocol.Default behaviour is strong SSL check.
+weaksslcheck - The request a certificate from the peer will be happened, but does not require this certificate to be valid.noweaksslcheck - No SSL certificate verification. This can be useful if you are testing a web server using a developer/local certificate on local machine.For scripting in application uses JavaScript language.
+Post scripts have access to global objects response and result. Object response using for get data about result of HTTP request. Object result usings for set of result validation HTTP request.
headers - array contains all response headers with values in format HeaderName HeaderValue.
+statusCode - number in range 0-600 from HTTP status code.
+errorMessage - if the request was in error, this field will contain a description of the error.
+bodySize - number from header Content-Length (or the actual size of the response body if not specified).
+route - the final URL with which the request was launched.
hasErrors (editable) - indicate if some error happened while postsctipr works.
+errorMessage (editable) - may contain a description of the user's error, which is displayed next to the status code in the results tab.
Check status code it is equal 200 (OK):
+postscript result.hasErrors = response.statusCode == 200;
+Check if the response has a server header:
postscript
+if(!response.headers.find(a => a.indexOf("server"))) {
+ result.hasErrors = true;
+ result.errorMessage = "Header server not specified!!!";
+}
+' + escapeHtml(summary) +'
' + noResultsText + '
'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 0000000..8812b5b --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"ArdorQuery Cross-platform desktop is a tool for making HTTP(S) requests from websites or RESTful APIs. Similar to cURL, but with a graphical interface. Can be used for testing and/or developing web applications. Application have minimal user interface and keyboard oriented. The HTTP request is broken down into a human-readable set of lines. Each line describes the type at the beginning, for example url means we define the URL for the HTTP request. Each type of line has a different color to help visually identify that content. Download You can always download the latest stable version from this link . Getting started Getting started and Basic shortcuts Fields Options Postscripting Feedback If you find a bug or have suggestions for the application, feel free to post an issue or discussion in the repository .","title":"Home"},{"location":"#ardorquery","text":"Cross-platform desktop is a tool for making HTTP(S) requests from websites or RESTful APIs. Similar to cURL, but with a graphical interface. Can be used for testing and/or developing web applications. Application have minimal user interface and keyboard oriented. The HTTP request is broken down into a human-readable set of lines. Each line describes the type at the beginning, for example url means we define the URL for the HTTP request. Each type of line has a different color to help visually identify that content.","title":"ArdorQuery"},{"location":"#download","text":"You can always download the latest stable version from this link .","title":"Download"},{"location":"#getting-started","text":"Getting started and Basic shortcuts Fields Options Postscripting","title":"Getting started"},{"location":"#feedback","text":"If you find a bug or have suggestions for the application, feel free to post an issue or discussion in the repository .","title":"Feedback"},{"location":"basicshortcuts/","text":"Getting started and Basic shortcuts Any HTTP request in an application is represented as a set of lines, each line contains some field. Each field contains a separate part of the HTTP request, such as a URL address, method, header, parameter, etc. There can be only one selected field, and it is highlighted with a colored frame. Simple steps to get started with the application Once application is launched, enter url https://github.com/ in the one existing field. You need to add a new field by pressing Ctrl-Enter ( Cmd-Enter on macOS). Enter in the new field - method GET To make an HTTP request, press Ctrl-Z or F5 . For change tab on Result need press F11 . After the HTTP request completes, you can see the Status , Response Time and Response Size , headers and body of the response if it was received from the server. Most used shortcuts: List of keyboard shortcuts F1 or Ctrl-H - If you forgot a shortcut, you can check it at any time in the popup-help. It contains search by name or keyboard shortcut. Manage fields Ctrl-Enter - Adding a new empty field below the selected field. Alt-Enter - Adding a new empty field on top of the selected field. Shift-Enter - Adding a new empty field at the end of the fields. Tabs management F11 - Switching between tabs for HTTP request fields and Result . Executing the request Ctrl-Z or F5 - Run HTTP request Ctrl-B or F4 - Cancel an HTTP request if it is not completed You can check the full documentation about all fields at this link","title":"Getting started"},{"location":"basicshortcuts/#getting-started-and-basic-shortcuts","text":"Any HTTP request in an application is represented as a set of lines, each line contains some field. Each field contains a separate part of the HTTP request, such as a URL address, method, header, parameter, etc. There can be only one selected field, and it is highlighted with a colored frame.","title":"Getting started and Basic shortcuts"},{"location":"basicshortcuts/#simple-steps-to-get-started-with-the-application","text":"Once application is launched, enter url https://github.com/ in the one existing field. You need to add a new field by pressing Ctrl-Enter ( Cmd-Enter on macOS). Enter in the new field - method GET To make an HTTP request, press Ctrl-Z or F5 . For change tab on Result need press F11 . After the HTTP request completes, you can see the Status , Response Time and Response Size , headers and body of the response if it was received from the server. Most used shortcuts:","title":"Simple steps to get started with the application"},{"location":"basicshortcuts/#list-of-keyboard-shortcuts","text":"F1 or Ctrl-H - If you forgot a shortcut, you can check it at any time in the popup-help. It contains search by name or keyboard shortcut.","title":"List of keyboard shortcuts"},{"location":"basicshortcuts/#manage-fields","text":"Ctrl-Enter - Adding a new empty field below the selected field. Alt-Enter - Adding a new empty field on top of the selected field. Shift-Enter - Adding a new empty field at the end of the fields.","title":"Manage fields"},{"location":"basicshortcuts/#tabs-management","text":"F11 - Switching between tabs for HTTP request fields and Result .","title":"Tabs management"},{"location":"basicshortcuts/#executing-the-request","text":"Ctrl-Z or F5 - Run HTTP request Ctrl-B or F4 - Cancel an HTTP request if it is not completed You can check the full documentation about all fields at this link","title":"Executing the request"},{"location":"commonfields/","text":"Fields Fields marked [single] must only be specified once in the request. If you specify them several times, the value will be taken from the last line in order. Basic fields url X [single] Specifies URL for the HTTP request, where X it full URL. Example: url https://github.com method X [single] Specifies the HTTP request method. Where X can be one of the possible values: GET , POST , PUT , DELETE , PATCH . Example: method POST body X [single] Specify the content in the body for the HTTP request. Example: body {\"jsonField\": \"jsonValue\" } Form fields form X=Y Add form field where X it name of field and Y it value. Example: form count=100 file X=Y Add file field where X it name of file field and Y it full path for file in filesystem. Example: file poster=~/images/poster.jpg Header fields