Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sunny-chung committed Feb 13, 2024
1 parent 654b799 commit 5a6f2f5
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ Watch the images and videos on the [website](https://sunny-chung.github.io/hello
- DELETE
- OPTIONS
- HEAD
- any other custom defined
- with request body varieties:
- Form URL-encoded
- Multipart Form with file upload
Expand Down Expand Up @@ -98,10 +99,12 @@ Watch the images and videos on the [website](https://sunny-chung.github.io/hello
- Message streaming from gRPC communications
- Persistence per request example
- Searching in response body
- Collapsable JSON response body
- Filtering JSON response body by [JSON path](https://github.com/json-path/JsonPath)
- Automatic gzip / deflate decompression
- Connection security indicator (Unencrypted / Unverified TLS / Verified One-way TLS / Verified mTLS)
- Certificates in use
- Handy buttons for copying responses to clipboard

**Appearance and Interactions**
- Dark and light theme
Expand Down
Binary file added doc/_include/collapse-json.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_include/copy-response.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_include/custom-http-method.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions doc/features/custom-http-methods.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Custom HTTP Methods
---

# Custom HTTP Methods

Besides built-in HTTP methods, custom HTTP methods can be inputted and used for HTTP requests. Method names are validated against the RFC 2616 specification.

![Use a Custom HTTP Method](../custom-http-method.gif)
12 changes: 12 additions & 0 deletions doc/features/viewing-responses.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,15 @@ documented [here](https://github.com/json-path/JsonPath).

![Filtering JSON Response](../response-json-filtering.gif)

## Collapse/Expand JSON Data Structures

JSON arrays and objects can be collapsed and expanded.

![Collapse/Expand JSON Data Structures](../collapse-json.gif)

## Copying Responses

Hover any copiable fields and click the "copy" button to copy. A prompt is displayed if copying is successful.

![Copying Responses](../copy-response.gif)

1 change: 1 addition & 0 deletions doctave.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ navigation:
children:
- path: doc/features/project-and-request-management.md
- path: doc/features/request-examples-and-payload-examples.md
- path: doc/features/custom-http-methods.md
- path: doc/features/environments.md
- path: doc/features/ssl-configuration.md
- path: doc/features/functions.md
Expand Down

0 comments on commit 5a6f2f5

Please sign in to comment.