Nutty Penguin Music

    httpyac-plugin-jq

    0.2.2 • Public • Published

    httpyac-plugin-jq

    A HttpYac plugin to easily apply jq commands to the response output. Based on node-jq.

    build

    Installation

    npm install httpyac-plugin-jq --save
    

    Usage

    Plugin adds support for JSON response processing with jq on the returned payload. This is usefull when e.g. explorative testing an API, but only focus on certain attributes. It's enabled via meta data instruction # @jq <command>. See jq and node-jq what commands can be applied.

    If response doesn't have content-type application/json set, the meta data instruction will be ignored.

    If jq command fails, the response stays untouched and a warning is shown.

    Example

    Following example filters the json response to show just title attribute of each object in slideshow.slides array list:

    # @name example
    # @jq .slideshow.slides | map({title})
    GET https://httpbin.org/json
    
    

    Results in:

    [
      {
        "title": "Wake up to WonderWidgets!"
      },
      {
        "title": "Overview"
      }
    ]

    Note

    The result is for display only and doesn't alter the actual response body value. So in any following requests access to the response data remains as usual (for the given example above):

    ...
    
    ### next request
    # @ref example
    GET https://httpbin.org/anything?author={example.slideshow.author}
    
    

    TODO

    Install

    npm i httpyac-plugin-jq

    DownloadsWeekly Downloads

    0

    Version

    0.2.2

    License

    ISC

    Unpacked Size

    17 kB

    Total Files

    13

    Last publish

    Collaborators

    • rngtng