@readme/oas-to-har

Utility to transform an OAS operation into a HAR representation

Usage no npm install needed!

<script type="module">
  import readmeOasToHar from 'https://cdn.skypack.dev/@readme/oas-to-har';
</script>

README

@readme/oas-to-har

Utility to transform an OAS operation into a HAR representation

Build

Installation

npm install --save @readme/oas-to-har

Usage

const Oas = require('oas');
const oasToHar = require('@readme/oas-to-har');

const spec = new Oas('petstore.json');
console.log(oasToHar(spec, { path: '/pets', method: 'post'}));

oasToHar(har, operationSchema, values, auth, opts) => Object

  • oas {Oas}: Instance of our oas/tooling class.
  • operationSchema {Object|Operation}: Can either be an object with path and method properties (that exist in the supplied OAS), or an instance of our Operation class from oas/tooling - accessed through new Oas(spec).operation(path, method).
  • values {Object}: A object of payload data, with key-value data therein, that should be used to construct the request. Available data you can define here:
    • path
    • query
    • body
    • cookie
    • formData
    • header
    • server — If the supplied OAS has multiple severs or server variables you can use this to set which server and variables to use. Shape of it should be: { selected: Integer, variables: { ...key-values }}. selected should coorespond to index of the servers array in your OAS.
  • auth {Object}: Authentication information for the request.
  • opts.proxyUrl {Boolean}: Boolean to toggle if composed HAR objects should have their url be sent through our CORS-friendly proxy. Defaults to false.

Credits

Jon Ursenbach

License

ISC