Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add online debug to USER_GUIDE.md #1091

Merged
merged 2 commits into from
Dec 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/USER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,34 @@ The Route module aims to control routes by UI instead of calling APIs.

![route-create-done-list-en](./images/route-create-done-list-en.png)

### Online debug

We can debug a route both published or offline with the online debug function, which is located in the routes list page.

1. Debug a published route

![route-debug-published](./images/route-debug-published.png)

2. Debug a offline route

![route-debug-offline](./images/route-debug-offline.png)

3. Debug a published route with query params

![route-debug-query-params](./images/route-debug-query-params.png)

4. Debug a published route with header params

![route-debug-header-params](./images/route-debug-header-params.png)

5. Debug a published route with body params

![route-debug-body-params](./images/route-debug-body-params.png)

6. Debug a published route with basic auth

![route-debug-basic-auth](./images/route-debug-basic-auth.png)

## Setting

![setting](./images/setting-en.png)
Binary file added docs/images/route-debug-basic-auth.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/route-debug-body-params.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/route-debug-header-params.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/route-debug-offline.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/route-debug-published.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/route-debug-query-params.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.