@har-sdk/oas

npmpackage.info

Gathering detailed insights and metrics for @har-sdk/oas

Other packages similar to @har-sdk/oas

@har-sdk/core

1.5.0

The base package can be used to import specification files (i.e. HAR, OAS and Postman Collection) and detect their type.

@har-sdk/openapi-sampler

2.4.2

[![Maintainability](https://api.codeclimate.com/v1/badges/4acaec95c82465cb2c3d/maintainability)](https://codeclimate.com/github/NeuraLegion/har-sdk/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/4acaec95c82465cb2c3d/test_coverage

@har-sdk/validator

2.6.1

A validator for HAR v1.2 Spec, OpenAPI and Postman documents.

@har-sdk/types

1.1.10

**THIS PACKAGE HAS BEEN DEPRECATED. THE DEVELOPMENT HAS MOVED TO A [@HAR-SDK/CORE](https://github.com/NeuraLegion/har-sdk/tree/master/packages/oas#readme) PACKAGE**

Gathering detailed insights and metrics for @har-sdk/oas

@har-sdk/oas

Transform your Swagger/OAS spec files into a series of HAR request objects.

Automatically generates fake data for all parameters

Compatible with Swagger and OAS specifications

Simple and easy-to-use API

With this library, you can easily generate requests with fake data to test your API using AutoCannon or DevTools.

Usage

To covert your specification, use the oas2har function as follows:

1import schema from './swagger.json' assert { type: 'json' }; 2import { oas2har } from '@har-sdk/oas'; 3 4const requests = await oas2har(schema); 5console.log(requests);

YAML files can also be loaded using js-yaml, as shown below:

1import { oas2har } from '@har-sdk/oas'; 2import { readFile } from 'node:fs/promises'; 3import yaml from 'js-yaml'; 4 5const content = yaml.load(await readFile('./swagger.yaml', 'utf-8')); 6const requests = await oas2har(content); 7console.log(requests);

If you have your specification hosted remotely, you can use a library like axios to fetch it and then convert it to a HAR. Here's an example:

1import axios from 'axios'; 2import { oas2har } from '@har-sdk/oas'; 3 4const url = 'https://example.com/swagger.json'; 5const response = await axios.get(url); 6const requests = await oas2har(response.data); 7console.log(requests);

Some specifications may incorporate example values for parameters provided in vendor extension fields, to include such examples in output use the oas2har function as follows:

1import schema from './swagger.json' assert { type: 'json' }; 2import { oas2har } from '@har-sdk/oas'; 3 4const requests = await oas2har(schema, { includeVendorExamples: true }); 5console.log(requests);

Notice the includeVendorExamples option affects Swagger specifications only.

Some specifications may have configuration for Accept header value in request parameters section. The automatically inferred Accept header values may be skipped, to skip these inferred values in output use the oas2har function as follows:

1import schema from './swagger.json' assert { type: 'json' }; 2import { oas2har } from '@har-sdk/oas'; 3 4const requests = await oas2har(schema, { skipAcceptHeaderInference: true }); 5console.log(requests);

Other packages similar to @har-sdk/oas

Other packages similar to @har-sdk/oas

Installations

Developer Guide

Yes

CommonJS

18.20.7

10.8.2

Pull Requests

6

176

13

157

Issues

12

102

90

Releases

Languages

Developer

NeuraLegion

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

@har-sdk/oas

Setup

Usage

License

10

10

10

10

5

0

0

0

0

0

0

0

4.1

/10