Skip to content

oslabs-beta/hypnos

Repository files navigation

PRs Welcome License: MIT

HYPNOS

Welcome to Hypnos(beta), a streamlined desktop application to sandbox GraphQL calls to RESTful APIs using the Apollo-link-rest package from Apollo Client, as well as giving detailed, helpful error messages.

* We recently added tabs to handle multiple entries!

Getting Started

Requirements

All you need to do is download your respective OS package, install, and go!

How to Install

Download for Mac or Windows (Linux coming soon!)

Mac: hypnos-0.0.2.dmg

Windows Zipped Config: hypnos-0.0.2.zip

Install the app to your applications folder.

How to Use

Enter your API endpoint

Hypnos supports calls to both open APIs and APIs requiring a key. Future versions will include support for APIs requiring Basic Auth and Oauth2

Enter your Apollo-link-rest query

A sample query is provided. Further documentation on Apollo-link-rest calls can be found in the Apollo GraphQL documents here: https://www.apollographql.com/docs/link/links/rest/

Hypnos will return the GraphQL response or meaningful errors

If there are any errors in query formatting, they will be displayed on the right

Features

Hypnos History

Hypnos will store your local query history, persisting queries from your sessions. You can delete your entire history, or you can delete individual queries. You also have the option of repopulating the current tab with a previous query.

Tabs

Want to submit another query, but don't want to submit your current query just yet? Just open up a new tab! Hypnos will save the endpoint and query, and you can come back to it later.

Authenticated APIs

A majority of APIs require a key in order to gain access to their endpoints, but have no fear: Hypnos supports API keys. Type in your endpoint and query as you would normally, but before you submit the query, go to Submit API Key. Clicking on it will open a new window in which you can enter the key for your headers and the API key given to you by the API itself. Once you submit the keys, you can go ahead and submit your query.

Resources

Built with Electron and React

Authors: Dillon Garrett, Sophie Nye, Will Robinson