You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+46-39Lines changed: 46 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,79 +20,82 @@ Swell is available for OSX, Linux, and Windows.
20
20
21
21
Swell is a one-stop shop for sending and monitoring your API requests:
22
22
23
-
- Send and monitor streams over HTTP2 / HTTP1 (including SSEs) and WebSockets
23
+
- Send and monitor streams over HTTP/2 (including SSEs) and WebSockets
24
24
- Create GraphQL queries, introspections, mutations, and subscriptions
25
-
- Stress testing HTTP/2 endpoints
25
+
- Stress testing HTTP/2 and GraphQL endpoints
26
+
- Create your own HTTP/2 mock server
26
27
- Store workspaces of multiple requests for later use
27
28
- Import and export workspaces locally
28
-
- Make API requests based on a range of provided options that conform to the specifications defined in OpenAPI documents.
29
-
- Verify STUN and TURN server connectivity for WebRTC applications by generating an SDP (Session Description Protocol)
30
-
- Diagnose and monitor your gRPC streaming connections
31
-
- Make customizable requests to TypeScript Remote Procedure Call (tRPC) endpoints
32
-
- View response timing information and history in an interactive chart for each request
33
29
- Compose test suites in JavaScript with Chai-style TDD/BDD assertion syntax
34
30
35
-
## Supported Technologies
31
+
## Core features
36
32
37
33
-_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.
Calls are currently being made using Swell's own TRPCProxyClient generated from the URL provided by the user.
54
-
Batch requests must be entered one request per line. Swell will treat each line of code entered into the editor as a separate request before batching and returning responses.
55
-
Each request must follow the general format client.procedure.querytype(). For example:
56
-
57
-
```js
58
-
client.getUser.query({ name:'Luke Skywalker' });
59
-
```
60
-
61
-
See [tRPC docs](https://trpc.io/docs/) for more information on sending tRPC requests or setting up a tRPC server.
42
+
-_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.
-_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 your favors test-driven development, Swell allows you to write assertion tests to aid defining and testing backend API services.
-_Scripting in Swell_: If you favor test-driven development, Swell allows you to write assertion tests to aid defining and testing backend API services.
-_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.
-_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.
Calls are currently being made using Swell's own TRPCProxyClient generated from the URL provided by the user.
83
+
Batch requests must be entered one request per line. Swell will treat each line of code entered into the editor as a separate request before batching and returning responses.
84
+
Each request must follow the general format client.procedure.querytype(). For example:
85
+
86
+
```js
87
+
client.getUser.query({ name:'Luke Skywalker' });
88
+
```
83
89
84
-
**Clone this repo and check out dev mode for the latest and greatest!**
90
+
See [tRPC docs](https://trpc.io/docs/) for more information on sending tRPC requests or setting up a tRPC server.
85
91
86
92
-_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.
-_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.
Currently, it is a read-only feature. When the write feature for ICE server is enable, ICE server details can be entered as an array of JavaScript objects (example code block below). An RTCPeerConnection will be instantiated, as an SDP is generated.
98
+
Currently, it is a read-only feature. When the write feature for ICE server is enabled, ICE server details can be entered as an array of JavaScript objects (example code block below). An RTCPeerConnection will be instantiated, as an SDP is generated.
96
99
97
100
```js
98
101
[
@@ -108,8 +111,8 @@ Swell is a one-stop shop for sending and monitoring your API requests:
108
111
];
109
112
```
110
113
111
-
-_UI Updates_: Built with Material UI, a smoother, more intuitive interface for enhanced user experience. Resizable panels between composer, response, and workspace and visual feedbackfor when users is selecting different communication protocols.
0 commit comments