Skip to content

README.md

Latest commit

 

History

History
102 lines (71 loc) · 2.46 KB

README.md

File metadata and controls

102 lines (71 loc) · 2.46 KB
Raw

Examples

Sample configs and patterns for DevPeek. These are illustrative snippets — adjust hosts, keys, and scripts for your environment.

Full UI walkthroughs: devpeek.ypgao.com/docs

Status

Category In this repo Notes
Param transform (Base64 field) Below Import via app UI or config export
Mock auto-response Below Use visual Mock wizard when possible
Forward / Map Route Below Plain-text forward rules

Contributions welcome via Discussions — share sanitized configs (no real secrets).

Base64 query field (concept)

Goal: Decode a Base64 token query param for inspection; re-encode on send.

{
  "comment": "Configure equivalent rule in DevPeek param transform UI",
  "match": {
    "host": "api.example.com",
    "pathPrefix": "/v1/login"
  },
  "fields": [
    {
      "location": "query",
      "key": "token",
      "transform": "base64-decode"
    }
  ]
}

Website: param transform docs

Mock: return fixed JSON for an endpoint

Goal: When GET /v1/user/profile is called, respond with a static JSON body without hitting the backend.

Use the visual Mock wizard from a captured request when you can — it picks URL and param traits automatically.

Manual rule shape (conceptual):

{
  "comment": "Created via Mock wizard preferred",
  "match": {
    "method": "GET",
    "host": "api.example.com",
    "path": "/v1/user/profile"
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": "{\"id\":1,\"name\":\"demo-user\"}"
  }
}

Website: Mock docs

Forward rule (Map Route)

Goal: Map h5.example.com to a local dev server.

Plain-text forward rules (one mapping per line):

h5.example.com	http://localhost:3300
api.example.com	http://127.0.0.1:8080

Website: Map Route docs

Export / import full config

DevPeek can export settings (including rules) from Preferences → Export config. Use that to backup before trying examples.

Website: Install & preferences

Related GitHub docs