From 4134d9f0d55f371a90281fbd78f1975380793210 Mon Sep 17 00:00:00 2001 From: Mitja Felicijan Date: Fri, 6 Feb 2026 03:51:38 +0100 Subject: Update readme with basic example --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index b9b53b8..b7832e5 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,38 @@ Hepi is a command-line tool for testing REST APIs using YAML-based configuration go install github.com/mitjafelicijan/hepi@latest ``` +## Basic example + +```yaml +environments: + local: + host: http://localhost:8080 + +requests: + login: + method: POST + url: "{{host}}/v1/auth/login" + description: "Authenticate and get a token" + headers: + Content-Type: "application/json" + json: + username: "admin" + password: "secret-password" + + get_profile: + method: GET + url: "{{host}}/v1/profile" + description: "Fetch user profile using the token from login" + headers: + Authorization: "Bearer {{login.token}}" + Accept: "application/json" + +groups: + auth_flow: + - login + - get_profile +``` + ## CLI Usage ### Basic Usage -- cgit v1.2.3