Giter Site home page Giter Site logo

parkreiner / swell Goto Github PK

View Code? Open in Web Editor NEW

This project forked from open-source-labs/swell

0.0 0.0 0.0 432.12 MB

Swell: API development tool that enables developers to test endpoints served over streaming technologies including Server-Sent Events (SSE), WebSockets, HTTP2, GraphQL, gRPC, and tRPC..

Home Page: http://www.getswell.io

License: MIT License

JavaScript 45.04% Python 0.75% TypeScript 51.64% CSS 0.22% HTML 0.10% SCSS 2.24%

swell's Introduction

Swell

License: MIT GitHub package.json version contributions welcome Tweet

Swell is an API development tool that enables developers to test HTTP2, GraphQL endpoints, as well as ones served over streaming technologies including Server-Sent Events (SSE), WebSockets, gRPC, WebRTC, and OpenAPI.

Getting Started

Visit www.getswell.io to download the latest release.

Swell is available for OSX, Linux, and Windows.

Highlights

Swell is a one-stop shop for sending and monitoring your API requests:

  • Send and monitor streams over HTTP/2 (including SSEs) and WebSockets
  • Create GraphQL queries, introspections, mutations, and subscriptions
  • Stress testing HTTP/2 and GraphQL endpoints
  • Create your own HTTP/2 mock server
  • Store workspaces of multiple requests for later use
  • Import and export workspaces locally
  • Compose test suites in JavaScript with Chai-style TDD/BDD assertion syntax

Core features

  • HTTP2: Swell supports full HTTP2 multiplexing of requests and responses. HTTP requests to the same host will be sent over the same connection. Swell will attempt to initiate an HTTP2 connection for all HTTPS requests by default, with the ability to revert to HTTP1.1 for legacy servers. Multiple concurrent streams are allowed for each connection.

  • GraphQL: Swell includes full support for all three root types of GraphQL - queries, mutations, and subscriptions – as well as Introspection. Variables are also supported, making creating queries easy.

  • Server-Sent Events (SSE): Initiated by a simple toggle box, Swell displays SSE events one by one as they come in. Similar to HTTP2 streams, multiple open connection streams are allowed for SSE.

  • WebSockets (WS): Swell enables connecting directly to WebSocket servers with an HTTP handshake, with developers able to send messages to the connected WS server directly. All outgoing and incoming messages are displayed in real time.

  • gRPC: Swell includes full support for all four streaming types of gRPC - unary, client stream, server stream, bidirectional stream.

  • tRPC: Swell includes full support for all methods of TypeScript Remote Procedure Calls including batch call support for queries and mutations as well as subscription

    Calls are currently being made using by using http get and post request using TRPC's http RPC specification (See RPC docs). TLDR- inputs for query procedures will be turn into uri-encoded json string and send as query param while inputs for mutate procedures will be store inside of the body.

    Batch requests can be made by adding multiple procedures before sending out the request, all query procedures will get batch together into one singular get request and all mutate procedures will get batch together into one singular put request, if there are mixture of query and mutate procedures call in one request, the app will send out both a post and get request concurrently and combine the response into one response.

    Nested endpoint must follow the general format parentEndpoint.childEndpoint.grandchildEndpoint. For example:

    client.user.update.mutate({ userId: '1', name: 'Luke' });

    A request to the above endpoint must have the mutate option selected from the drop down menu, must have an endpoint of .user.update and a input body of {"userId": "1","name": "Luke"}

    See tRPC docs for more information on sending tRPC requests or setting up a tRPC server.

Additional features

  • Stress testing for HTTP/2 and GraphQL: Test your server backend with Swell's stress testing feature to ensure your server can manage expected and unexpected loads accordingly

  • Send Requests Directly to an Endpoint: You are able to immediately send a request to an endpoint OR stage a request in your workspace for multi-level testing.

  • Scripting in Swell: If you favor test-driven development, Swell allows you to write assertion tests to aid defining and testing backend API services.

  • Workspaces: Swell allows you to save workspaces for easier testing of multiple requests.

  • Preview: You can now view a rendered preview of certain API responses (HTML)

  • Collection Runner: You can also stage requests in the workspace and automate the process of sending off each one. No need to manually press send on each one; instead each request will fire off in the order of staging.

Experimental Features

  • Mock Server: Swell allows you to create your own HTTP/2 mock server to facilitate front-end development without depending on a fully built backend server.

  • Webhooks: Swell includes user-defined HTTP callback connection testing designed to test other server's connection to the web and ability to send data. The test insures that when an event occurs, the source site makes an HTTP request to the URL configured for the webhook.

  • WebRTC: Swell makes it easy to test WebRTC applications for both video and text channels. Currently Swell supports manual entry of SDPs.

  • OpenAPI: Swell supports the enumeration and execution of REST and RPC API requests as defined in a user-provided OpenAPI document.

Built With

  • Electron
  • React
  • React Router
  • Material UI
  • Redux
  • Apollo Client
  • Websockets
  • gRPC-js
  • tRPC
  • VM2
  • Chart.js
  • Bulma
  • IndexedDB
  • Chai
  • Mocha
  • Playwright

Considering iterating Swell in the future?

Feel free to check out the DEV-README.md in the docs folder.

Authors

License

This project is licensed under the MIT License

swell's People

Contributors

texpatnyc avatar garyslootskiy avatar alexsanhueza avatar cgefx avatar nathanielbadams avatar danst3in avatar nattiechan avatar abbychao avatar myttins avatar jasonligg avatar edwardcho1231 avatar nancyddao avatar nickhealy avatar stephwood avatar johnmadrigal avatar whtait avatar miggonzalez avatar esclarsky avatar parkreiner avatar ywy-w avatar egrobar avatar mjmiguel avatar samhaar avatar h15200 avatar blast61 avatar michaelgprince avatar brandon6190 avatar addoasa avatar andrea-gli avatar wcbell51 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.