npmpackage.info

@har-sdk/oas

HAR SDK enables Node.js developers to easily work with HAR, convert it from OAS/Swagger and Postman collection, and more.

2.10.0

MIT

TypeScript

49.24 kB

22,103 4

Installations

npm install @har-sdk/oas

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

18.20.4

NPM Version

10.7.0 Score

73.8

Supply Chain

93.9

Quality

81.8

Maintenance

100

Vulnerability

99.1

License

Pull Requests

Open

9

Total

161

Closed

11

Merged

141

Issues

Open

12

Total

93

Closed

81

Releases

214

@har-sdk/oas@2.10.0

Published on 07 Oct 2024

@har-sdk/postman@2.4.6

Published on 22 Aug 2024

@har-sdk/oas@2.9.3

Published on 22 Aug 2024

@har-sdk/oas@2.9.2

Published on 14 Aug 2024

@har-sdk/openapi-sampler@2.2.1

Published on 14 Aug 2024

@har-sdk/oas@2.9.1

Published on 22 Apr 2024

View all 214 releases

Contributors

Unable to fetch Contributors

View all 25 contributors

Languages

TypeScript

JavaScript

Shell

TypeScript (98.02%)

JavaScript (1.94%)

Shell (0.04%)

Developer

NeuraLegion

Download Statistics

Total Downloads

22,103

Last Day

Last Week

188

Last Month

527

Last Year

7,252

GitHub Statistics

11 Stars

142 Commits

5 Forks

16 Watching

10 Branches

25 Contributors

Bundle Size

157.07 kB

Minified

49.24 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.10.0

Package Id

@har-sdk/oas@2.10.0

Unpacked Size

261.70 kB

Size

64.24 kB

File Count

186

NPM Version

10.7.0

Node Version

18.20.4

Publised On

07 Oct 2024

Total Downloads

Cumulative downloads

Total Downloads

22,103

Last day

37.5%

Compared to previous day

Last week

198.4%

188

Compared to previous week

Last month

-8.7%

527

Compared to previous month

Last year

-10.2%

7,252

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@apidevtools/json-schema-ref-parser @har-sdk/core @har-sdk/openapi-sampler json-pointer jstoxml qs tslib url-template

Dev Dependencies

@types/js-yaml @types/json-pointer @types/jstoxml @types/qs @types/url-template js-yaml

Versions

@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.

Setup

To install the library, run the following command:

1$ npm i --save @har-sdk/oas

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);

License

This project is licensed under the MIT License - see the LICENSE file for details.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

5

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 5

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/auto-build.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/auto-build.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/NeuraLegion/har-sdk/auto-build.yml/master?enable=pin
Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 3 out of 3 npmCommand dependencies pinned

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @har-sdk/oas

@har-sdk/core

1.4.5

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

@har-sdk/types

1.1.9

**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**

@har-sdk/editor

1.5.12

Parses OAS and Postman API specification files into form of tree with endpoints and parameters as leaves; tree is useful for GUI representation of specification parameters

@har-sdk/validator

2.5.0

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