search

jenius-apps / nightingale-rest-api-client

A modern, resource-efficient REST API client for Windows
https://nightingale.rest
MIT License
761 stars 36 forks source link

Feature request: Postman URI handler #27

Open bleachedsleet opened 4 years ago

bleachedsleet commented 4 years ago

Now that Nightingale is rolling out Postman collection importing it would be nice if it could register itself as a URI handler for "postman://" collection URIs. Postman collections are generally distributed via their own public site and are designed to be imported directly into Postman by launching a specially crafted URI that triggers an import into the Postman app. They give no direct download or export option from the distribution site (annoying, but it is what it is) so currently the only option to import these API collections into Nightingale would be to use either the depreciated Chrome extension or the Postman app and export the collection into JSON that could then be imported into Nightingale. This is not ideal and largely defeats the purpose of having Nightingale installed since Postman would also need to be on the same system.

Postman API collections are distributed here. An example URI for the Auth0 collection would be:

postman://app/collections/import/3967924-5bd51261-1bf3-03e4-b6b9-4e5fa5f59e6a-RW1Yq1C4?referrer=https%3A%2F%2Fexplore.postman.com%2Fapi%2F6%2Fauth0-authentication-api&versionTag=latest#?

Each collection has a unique UID that it is linked to and is used to identify the collection. This is outlined here in Postman's API documentation and it seems this is carried over into the URI schema that's used to launch an import command from within Postman.

I don't know if Nightingale could support this, but this would greatly reduce friction in switching API clients and immediately provide access to a vast network of already fleshed out API collections for developers to use. If there's one thing Postman is good at, it's getting the big companies on board with publicizing API documentation in a client-readable format and Nightingale needs to be able to benefit from this network.

dpaulino commented 4 years ago

Thanks @scratchfive for the thorough description! I will perform feasibility investigations soon. This is a great idea and I hope to add it into Nightingale.