Skip to content

Commit 2bae902

Browse files
authored
Merge pull request #327 from oslabs-beta/master
New Version 1.11.0
2 parents 61bf1e8 + 9e5f676 commit 2bae902

File tree

139 files changed

+5630
-5344
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

139 files changed

+5630
-5344
lines changed

README.md

Lines changed: 66 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
<p align="center"><img src="./src/assets/img/horizontal-logo-lockup.png" style="margin-top: 10px; margin-bottom: -10px;"></p>
1+
<img src="./src/assets/img/horizontal-logo-lockup.png" style="display: block; margin: 10px auto 30px;">
22

3-
#
3+
# Swell
44

55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/open-source-labs/Swell/blob/master/LICENSE.txt)
66
[![Build Status](https://travis-ci.org/open-source-labs/Swell.svg?branch=master)](https://travis-ci.org/open-source-labs/Swell)
@@ -14,94 +14,95 @@ Swell is an API development tool that enables developers to test endpoints serve
1414

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

17-
Swell is currently available for OS X, Linux and Windows.
17+
Swell is available for OSX, Linux, and Windows.
1818

1919
## Highlights
2020

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

2323
- Send and monitor streams over HTTP2 / HTTP1 (including SSEs) and WebSockets
2424
- Create GraphQL queries, introspections, mutations, and subscriptions
25-
- Make API requests based on a range of provided options that conform to the specifications defined in an OpenAPI document.
26-
- Verify STUN and TURN server connectivity for WebRTC applications by generating an SDP
27-
- Provides full streaming testing support for gRPC
25+
- Make API requests based on a range of provided options that conform to the specifications defined in OpenAPI documents.
26+
- Verify STUN and TURN server connectivity for WebRTC applications by generating an SDP (Session Description Protocol)
27+
- Diagnose and monitor your gRPC streaming connections
2828
- View response timing information and history in an interactive chart for each request
29-
- Save workspaces of multiple requests for later access
30-
- Import and export workspaces for sharing
29+
- Store workspaces of multiple requests for later use
30+
- Import, export, and share workspaces with other developers
3131
- Compose test suites in JavaScript with Chai-style TDD/BDD assertion syntax
3232
- Execute a collection of requests in succession and receive clear visual feedback of each test's status
33-
- Schedule requests on to be sent on a regular time interval to support endpoint functional validation tests
33+
- Schedule requests to be sent on a regular time interval to support endpoint functional validation tests
3434

3535
## Supported Technologies
3636

37-
- _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, but will revert to HTTP1.1 for legacy servers. Multiple concurrent streams are allowed for each connection.
38-
<kbd><img src="./ReadMeGifs/Gifs/ConcurrentStreams.gif" style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
37+
- _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.
38+
<img src="./ReadMeGifs/Gifs/HttpTesting.gif" style="display: block; margin: 10px auto 30px; border: 1px solid black;" />
3939

4040
- _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.
41-
<kbd><img src="./ReadMeGifs/Gifs/SSE.gif" style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px;" /></kbd>
41+
<img src="./ReadMeGifs/Gifs/SSE.gif" style="display: block; margin: 10px auto 30px;" />
4242

43-
- _WebSocket (WS)_: Swell enables connecting directly to WebSocket servers with an HTTP handshake. Developers can directly send messages to the connected WS server. Messages are displayed in chatbox format, clearly indicating outgoing and incoming messages.
44-
<kbd><img src="./ReadMeGifs/Gifs/WS.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
43+
- _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.
44+
<img src="./ReadMeGifs/Gifs/Websockets.gif" style="display: block; margin: 10px auto 30px;" />
4545

46-
- _GraphQL_: Swell includes full support for all three root types of GraphQL - queries, mutations, and subscriptions as well as Introspection - with and without variables. Smart code editor allows for easy query creation.
47-
<kbd><img src="./ReadMeGifs/Gifs/GraphQL.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
46+
- _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.
47+
<img src="./ReadMeGifs/Gifs/GraphQL.gif" style="display: block; margin: 10px auto 30px;" />
4848

4949
- _gRPC_: Swell includes full support for all four streaming types of gRPC - unary, client stream, server stream, bidirectional stream.
50-
<kbd><img src="./ReadMeGifs/Gifs/GRPCResponses.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
51-
52-
- _OpenAPI_: Swell supports the enumeration and execution of REST and RPC API requests as defined in a user-provided OpenAPI document.
53-
<kbd><img src="./ReadMeGifs/Gifs/openapi.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
54-
55-
- _WebRTC_: Swell enables testing STUN and TURN ICE server connectivity for WebRTC applications.
56-
<kbd><img src="./ReadMeGifs/Gifs/webrtc.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
57-
58-
Developers enter ICE server details as an array of JavaScript objects (example code block below). An RTCPeerConnection is instantiated and an SDP is generated.
59-
60-
```javascript
61-
[
62-
{
63-
urls: 'turn:111.222.333.444:54321',
64-
username: 'myAwesomeUsername',
65-
credential: 'mySecretPassword', // or token
66-
credentialType: 'password'
67-
},
68-
{
69-
urls: 'stun:555.777.888.999:43210',
70-
},
71-
]
72-
```
50+
<img src="./ReadMeGifs/Gifs/gRPC-responses.gif" style="display: block; margin: 10px auto 30px;" />
7351

52+
- _OpenAPI_: Swell supports the enumeration and execution of REST and RPC API requests as defined in a user-provided OpenAPI document.
53+
<img src="./ReadMeGifs/Gifs/openapi.gif" style="display: block; margin: 10px auto 30px;" />
54+
55+
- _WebRTC_: Swell makes it easy to test STUN and TURN ICE server connectivity for WebRTC applications.
56+
<img src="./ReadMeGifs/Gifs/webrtc.gif" style="display: block; margin: 10px auto 30px; " />
57+
58+
Once you enter ICE server details as an array of JavaScript objects (example code block below). An RTCPeerConnection will be instantiated, as an SDP is generated.
59+
60+
```js
61+
[
62+
{
63+
urls: 'turn:111.222.333.444:54321',
64+
username: 'myAwesomeUsername',
65+
credential: 'mySecretPassword', // or token
66+
credentialType: 'password',
67+
},
68+
{
69+
urls: 'stun:555.777.888.999:43210',
70+
},
71+
];
72+
```
7473

7574
## Additional Features
7675

77-
- _Send Request Directly to Endpoint_: You are able to immediately send a request to an endpoint OR stage a request in your workspace for multi-level testing.
78-
<kbd><img src="./ReadMeGifs/Gifs/DirectSendRequest.gif"
79-
style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
80-
- _Scripting in Swell_: Swell allows you to write assertion tests to aid in the test-driven development cycle of backend API services.
81-
<kbd><img src="./ReadMeGifs/Gifs/SimpleResponseTest.gif"
82-
style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
76+
- _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.
77+
<img src="./ReadMeGifs/Gifs/DirectSendRequest.gif"
78+
style="display: block; margin: 10px auto 30px; border: 1px solid black;" />
79+
- _Scripting in Swell_: If your favors test-driven development, Swell allows you to write assertion tests to aid defining and testing backend API services.
80+
<img src="./ReadMeGifs/Gifs/SimpleResponseTest.gif"
81+
style="display: block; margin: 10px auto 30px; border: 1px solid black;" />
8382
- _Workspaces_: Swell allows you to save workspaces for easier testing of multiple requests.
8483
- _Preview_: You can now view a rendered preview of certain API responses (HTML)
85-
<kbd><img src="./ReadMeGifs/Gifs/AdditionalFeatures.gif"
86-
style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
87-
- _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.
88-
<kbd><img src="./ReadMeGifs/Gifs/CollectionTest.gif"
89-
style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
90-
- _Schedule Tests_: You can also automate sending requests to occur on a periodic basis.
91-
<kbd><img src="./ReadMeGifs/Gifs/ScheduleTest.gif"
92-
style="float: left; margin-right: 10px; margin-bottom : 30px; margin-top : 10px; border: 1px solid black;" /></kbd>
84+
<img src="./ReadMeGifs/Gifs/AdditionalFeatures.gif"
85+
style="display: block; margin: 10px auto 30px; border: 1px solid black;" />
86+
- _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.
87+
<img src="./ReadMeGifs/Gifs/CollectionTest.gif"
88+
style="display: block; margin: 10px auto 30px; border: 1px solid black;" />
89+
- _Schedule Tests_: You can also automate sending requests cyclically.
90+
<img src="./ReadMeGifs/Gifs/ScheduleTest.gif"
91+
style="display: block; margin: 10px auto 30px; border: 1px solid black;" />
9392

9493
## WIP Features
94+
9595
**Clone this repo and check out dev mode for the latest and greatest!**
9696

97-
- _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.
98-
<kbd><img src="./ReadMeGifs/Gifs/Webhook.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
97+
- _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.
98+
<img src="./ReadMeGifs/Gifs/Webhook.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" />
99+
100+
- _Added in Dev Version 1.10.2!_ _UI Updates_: Built with Material UI, a smoother, more intutive interface for enhanced user experience.
101+
<img src="./ReadMeGifs/Gifs/NewUI.png" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" />
99102

100-
- *New in Dev Version 1.10.2!* _UI Updates_: Built with Material UI, a smoother, more intutive interface for enhanced user experience.
101-
<kbd><img src="./ReadMeGifs/Gifs/NewUI.png" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
103+
- _Added in Dev Version 1.10.2!_ _Github Integration + Import/Export Workspaces_: Swell allows you to import and export workspaces, making it easy to share collections with your team. You can even register with Github to save your workspaces directly into your repository!
104+
<img src="./ReadMeGifs/Gifs/GithubIntegration.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" />
102105

103-
- *New in Dev Version 1.10.2!* _Github Integration + Import/Export Workspaces_: Swell allows you to import and export workspaces, making it easy to share collections with your team. You can even register with Github to save your workspaces directly into your repository!
104-
<kbd><img src="./ReadMeGifs/Gifs/GithubIntegration.gif" style="float: left; margin-right: 10px;margin-bottom : 30px; margin-top : 10px;" /></kbd>
105106
## Built With
106107

107108
- Electron
@@ -174,11 +175,15 @@ Swell is a one-stop shop for sending and monitoring your API requests
174175
- **Jay Wall** - [hanswand](https://github.com/hanswand)
175176
- **Sam Pyo** - [samhpyo](https://github.com/samhpyo)
176177
- **Drew Pomatti** - [thedrewery](https://github.com/thedrewery)
177-
- **Kurtis Waterbury** - [kurto8](https://github.com/kurto8)
178+
- **Kurtis Waterbury** - [kurto8](https://github.com/kurto8)
178179
- **Yale Yng-Wong** - [ywy-w](https://github.com/ywy-w)
179180
- **Evelin Goldin** - [evelingoldin](https://github.com/evelingoldin)
180181
- **Alexander Adams** - [alex-e-adams](https://github.com/alex-e-adams)
181182
- **Ethan Sclarsky** - [esclarsky](https://github.com/esclarsky)
183+
- **Travis Lovis** - [tlovis](https://github.com/tlovis)
184+
- **HyeJin Kim** - [hyejinkim](https://github.com/hyejinkim)
185+
- **Alexa Nunes** - [A13xaNunes](https://github.com/A13xaNunes)
186+
- **Michael Smith** - [Parkreiner](https://github.com/Parkreiner)
182187

183188
## License
184189

ReadMeGifs/Gifs/GRPCResponses.gif

-1.6 MB
Binary file not shown.

ReadMeGifs/Gifs/GraphQL.gif

3.59 MB
Loading

ReadMeGifs/Gifs/HttpTesting.gif

6.63 MB
Loading

ReadMeGifs/Gifs/SSE.gif

356 KB
Loading

ReadMeGifs/Gifs/Websockets.gif

1.02 MB
Loading

ReadMeGifs/Gifs/gRPC-responses.gif

1.41 MB
Loading

0 commit comments

Comments
 (0)