npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

httpyac-import

v1.0.0

Published

CLI to convert Postman collection to httpyac files

Downloads

40

Readme

httpyac-import

CI CodeQL

CLI to convert a postman collection to httpyac file or files.

Usage

httpyac-import --sourcePath=sample.postman_collection.json --targetPath=output

  • sourcePath - path to the Postman collection json file
  • targetPath - path to the root of the .http files, will be created if it doesn't exist
  • ignoreHeaders - optional list of headers to ignore, useful when using default headers. Supports regex patterns (eg SomeHeader.*)
  • splitRequests - determines whether to split requests into separate files. Optional, defaults to true
  • target - either file or console, defaults to file
  • purgeTargetPath - determines whether to delete target path. Optional, defaults to false

Request Lines

Request lines are parsed and split onto multiple lines:

GET https://www.google.de?option=value

Will be output as:

GET https://www.google.de
    ?option=value

Scripts

Pre-request Scripts

All pre-request scripts will be commented out and marked with a TODO:

console.log('Some pre-request script');

Will be converted to:

{{
// TODO: Fixup Postman pre-request script
// console.log('Some pre-request script');
}}

Test Scripts

The utility attempts to convert the basic post-request test scripts to the httpyac equivalent:

Given a simple status test:

pm.test("Status test", function () {
    pm.response.to.have.status(201);
});

Will be converted to the concise httpyac equivalent:

?? status == 201

Two more known patterns will be converted to the the httpyac equivalent:

pm.test("Status test", function () {
    pm.response.to.have.status(201);
    pm.environment.set("someId", pm.response.json().id);
    pm.environment.set("someEtag", pm.response.headers.get("Etag"));
});

Will be converted to:

?? status == 201

{{
    $global.someId = response.parsedBody.id;
    $global.someEtag = response.headers.etag;
}}

More complicated assertions will be commented out and marked with a TODO:

pm.test("Status test", function () {
    pm.response.to.have.status(201);
    console.log(pm.response.json().id);
});

Will be converted to:

?? status == 201

{{
// TODO: Fixup Postman test script
// pm.test("Status test", function () {
//     pm.response.to.have.status(201);
//     console.log(pm.response.json().id);
// });
}}

Limitations

There is no current support for:

  • Non-javascript scripting languages
  • Non-JSON body in POST/PUT requests

Running from the repository

npm run import -- -- --sourcePath=sample.postman_collection.json --targetPath=output