Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Group Name : It simply groups all the actions performed within one single HTTP request into a single group.

  2. An Endpoint URL : An application implementing a RESTful API will define one or more URL endpoints with a domain, port, path, and/or query string
    For example, https://mydomain/user/123?format=json.

  3. Authentication : If an API requires authentication, the API Authentication can be created under “Configure” section (on the left pane) & used in the API test case.
    The API Authentications once created under the “Configure” section, are displayed under the authentication dropdown in the API test.

  4. The HTTP method : Different HTTP methods can be used on any endpoint which map to application create, read, update, and delete operations.
    There are various HTTP requests available in BQ Platform. They are :

    • GET

    • POST

    • PUT

    • PATCH

    • DELETE

    • HEAD

  5. HTTP headers : Information such as authentication token or cookies can be contained in the HTTP request header.

  6. Query String : Query string parameters appear after a question mark (?) in the endpoint URL.
    The parameters and their values (displayed after the question mark) are referred to as the “query string.”
    In the query string, each parameter is listed one after the other with an ampersand (&) separating them.
    The order of the query string parameters does not matter.
    For example : /surfreport/{beachId}?days=3&units=metric&time=1400
    The query string parameters in the above endpoint are : days=3 , units=metric and time=1400

  7. Body Data : Data is normally transmitted in the HTTP body in an identical way to HTML <form> submissions or by sending a single JSON-encoded data string.

  8. Extract and Store : When an HTTP request is made, data from the response can be retrieved, extracted and stored in a variable for further use.

  9. Assertions : Assertions is nothing but verification performed on the endpoint URL.

When & how to use the HTTP(S) Requests ?

GET Request

The HTTP GET request is used to retrieve requested data from a server. The data is identified by a unique URI (Uniform Resource Identifier).
A GET request can pass parameters to the server using "Query Parameters".

...

  • The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response.
    In other words, if GET /users returns a list of users, then HEAD /users will make the same request but won't get back the list of users.
    This method is often used for testing hypertext links for validity, accessibility, and recent modification.

  • This method can be used for obtaining meta information about the entity implied by the request without transferring the entity-body itself.

  • The meta information contained in the HTTP headers in response to a HEAD request SHOULD be identical to the information sent in response to a GET request.

How to pass data under each tab?

Header Parameters

Header Parameters tab is used to pass data in request header.

...