From 85b673177d49f3ecc4b5408647a9ba902f824ed8 Mon Sep 17 00:00:00 2001 From: Roy de Kleijn Date: Tue, 8 Sep 2026 19:42:04 +0200 Subject: [PATCH] changed the docs --- docs/compare/README.md | 3 +++ docs/compare/bruno.md | 5 ++++- docs/compare/insomnia.md | 5 ++++- docs/compare/kreya.md | 6 +++--- docs/compare/milkman.md | 4 +++- docs/compare/postman.md | 5 ++++- docs/compare/readyapi.md | 3 ++- docs/compare/soapui.md | 4 ++-- docs/compare/yaak.md | 5 ++++- src/renderer/src/components/RequestBuilder/ContractTab.tsx | 6 +++--- 10 files changed, 32 insertions(+), 14 deletions(-) diff --git a/docs/compare/README.md b/docs/compare/README.md index 930f33b..da1ed37 100644 --- a/docs/compare/README.md +++ b/docs/compare/README.md @@ -33,6 +33,9 @@ Where another tool is a better fit, these pages say so. and test-code export, instead of stitching several tools together. - **Broad protocol coverage.** REST/HTTP, GraphQL, SOAP, WebSocket, and gRPC (unary and server streaming) in one client. +- **Rich request authoring.** An introspection-driven GraphQL query builder, a + SOAP WSDL loader that generates the envelope for you, and secret-manager + integrations (Vault, AWS, Azure, 1Password) built in - not left to plugins. - **Export to real test code.** Robot Framework, Playwright, Karate, REST Assured, and supertest, so tests run in your existing stack, not locked in a proprietary runner. diff --git a/docs/compare/bruno.md b/docs/compare/bruno.md index defdf6b..3835485 100644 --- a/docs/compare/bruno.md +++ b/docs/compare/bruno.md @@ -20,7 +20,9 @@ narrow: it is a very good request client. | Local-first / offline | Yes | Yes | | Account required | No | No | | Storage | Files (Git-friendly) | Files, `.bru` markup (Git-friendly) | -| Secrets | AES-256-GCM local + Vault/AWS/Azure/1Password | Env files, `.env`, secret vars | +| Secret managers | Vault, AWS, Azure, 1Password (+ AES-256-GCM local) | Env files, `.env`, secret vars | +| GraphQL query builder | Yes, introspection-driven | Yes | +| SOAP + WSDL loader | Yes, load a WSDL and generate the envelope | No | | Export to test code | Robot Framework, Playwright, Karate, REST Assured, supertest | Not a focus | | Mock servers | Yes (local and cloud) | No | | Contract testing | Built in, Pact-compatible | No | @@ -32,6 +34,7 @@ narrow: it is a very good request client. Bruno and API Spector agree on the fundamentals, so the choice is about scope. +- **Author faster.** An introspection-driven GraphQL query builder, a SOAP WSDL loader that fills in the envelope, and Vault / AWS / Azure / 1Password secret references, all built in - no plugins. - **More of the workflow in one place.** If you also need mock servers, contract testing, or to generate runnable tests, API Spector covers those without adding another tool. diff --git a/docs/compare/insomnia.md b/docs/compare/insomnia.md index fbf2532..d3d27cb 100644 --- a/docs/compare/insomnia.md +++ b/docs/compare/insomnia.md @@ -17,7 +17,9 @@ features, which prompted some users to look for offline-first alternatives. |---|---|---| | Local-first / offline | Yes | Supported, but account and cloud are emphasised | | Account required | No | Prompted; some features gated | -| Secrets | AES-256-GCM local + external managers | Environment variables, plugins | +| Secret managers | Vault, AWS, Azure, 1Password (+ AES-256-GCM local) | Environment variables, plugins | +| GraphQL query builder | Yes, introspection-driven | Yes | +| SOAP + WSDL loader | Yes, load a WSDL and generate the envelope | No | | Export to test code | Robot Framework, Playwright, Karate, REST Assured, supertest | Snippets; Inso CLI for its own runner | | Contract testing | Built in, Pact-compatible | Not built in | | OpenAPI test coverage | Yes, with a CI gate | No | @@ -27,6 +29,7 @@ features, which prompted some users to look for offline-first alternatives. ## Where API Spector fits +- **Author faster.** An introspection-driven GraphQL query builder, a SOAP WSDL loader that fills in the envelope, and Vault / AWS / Azure / 1Password secret references, all built in - no plugins. - **No account, no nudging.** The app is fully usable offline with nothing to sign in to. - **From request to test code.** Export a collection to Robot Framework, diff --git a/docs/compare/kreya.md b/docs/compare/kreya.md index 30b578d..aa36808 100644 --- a/docs/compare/kreya.md +++ b/docs/compare/kreya.md @@ -19,10 +19,10 @@ freemium model and appeals to teams whose APIs are largely gRPC. |---|---|---| | gRPC | Yes (unary + server streaming) | Yes, deeper (client/bidi streaming, reflection) | | HTTP/REST | Yes | Yes | -| GraphQL | Yes | Limited | -| SOAP / WebSocket | Yes | Partial | +| GraphQL query builder | Yes, introspection-driven | Limited | +| SOAP + WSDL loader | Yes, WSDL-driven | Partial | | Local-first / offline | Yes | Yes | -| Secrets | AES-256-GCM local + external managers | Environment variables | +| Secret managers | Vault, AWS, Azure, 1Password (+ AES-256-GCM local) | Environment variables | | Export to test code | Robot Framework, Playwright, Karate, REST Assured, supertest | Not a focus | | Mock servers | Yes | No | | Contract testing | Built in, Pact-compatible | No | diff --git a/docs/compare/milkman.md b/docs/compare/milkman.md index be4f8f0..b6c82ef 100644 --- a/docs/compare/milkman.md +++ b/docs/compare/milkman.md @@ -20,7 +20,9 @@ It is community-driven, and capabilities depend on which plugins you add. | Account required | No | No | | Storage | Files (Git-friendly) | Files (Git-friendly) | | Out-of-the-box features | Client, mocks, contracts, code export | Core client; rest via plugins | -| Secrets | AES-256-GCM local + Vault/AWS/Azure/1Password | Plugin-dependent | +| Secret managers | Vault, AWS, Azure, 1Password (+ AES-256-GCM local) | Plugin-dependent | +| GraphQL query builder | Yes, introspection-driven | Plugin-dependent | +| SOAP + WSDL loader | Yes, load a WSDL and generate the envelope | Plugin-dependent | | Export to test code | Robot Framework, Playwright, Karate, REST Assured, supertest | Plugin-dependent | | Mock servers | Yes | Plugin-dependent | | Contract testing | Built in, Pact-compatible | No | diff --git a/docs/compare/postman.md b/docs/compare/postman.md index 55d1a3d..28899a1 100644 --- a/docs/compare/postman.md +++ b/docs/compare/postman.md @@ -21,7 +21,9 @@ tiers. | Runs fully offline | Yes | Limited; account and sync are central | | Account required | No | Effectively yes for most workflows | | Where data lives | Your machine (files) | Postman cloud by default | -| Secrets | AES-256-GCM local + Vault/AWS/Azure/1Password references | Vault/env; cloud-synced vault | +| Secret managers | Vault, AWS, Azure, 1Password (+ AES-256-GCM local) | Vault/env; cloud-synced vault | +| GraphQL query builder | Yes, introspection-driven | Yes | +| SOAP + WSDL loader | Yes, load a WSDL and generate the envelope | Manual, no WSDL import | | Export to test code | Robot Framework, Playwright, Karate, REST Assured, supertest | Snippets; runs in Postman's runner/Newman | | Contract testing | Built in, Pact-compatible | Via external tooling | | OpenAPI test coverage | Yes, with a CI gate | Partial (cloud platform inventory) | @@ -31,6 +33,7 @@ tiers. ## Where API Spector fits +- **Author faster.** An introspection-driven GraphQL query builder, a SOAP WSDL loader that fills in the envelope, and Vault / AWS / Azure / 1Password secret references, all built in - no plugins. - **Your data stays local.** No forced sign-in, no collections living in someone else's cloud. Good for regulated environments and anyone uneasy about API keys syncing off-machine. diff --git a/docs/compare/readyapi.md b/docs/compare/readyapi.md index f9a0d36..3b59a16 100644 --- a/docs/compare/readyapi.md +++ b/docs/compare/readyapi.md @@ -26,10 +26,11 @@ teams and is licensed commercially. | Service virtualization | Mock servers | Yes (ServiceV) | | Contract testing | Built in, Pact-compatible | Not a focus | | SOAP / REST | Yes | Yes | +| GraphQL query builder | Yes, introspection-driven | Limited | | gRPC | Yes (unary + server streaming) | No | | Export to test code | Robot Framework, Playwright, Karate, REST Assured, supertest | Its own runner + CI tooling | | Local-first / offline | Yes | Desktop; enterprise/cloud features | -| Secrets | AES-256-GCM local + external managers | Project properties / vault | +| Secret managers | Vault, AWS, Azure, 1Password (+ AES-256-GCM local) | Project properties / vault | ## Where API Spector fits diff --git a/docs/compare/soapui.md b/docs/compare/soapui.md index 19c6385..c1b51bb 100644 --- a/docs/compare/soapui.md +++ b/docs/compare/soapui.md @@ -22,7 +22,7 @@ builds on it with a modern UI and more features. |---|---|---| | SOAP / WSDL | Yes (WSDL-driven editor) | Yes, a core strength | | REST / HTTP | Yes | Yes | -| GraphQL / WebSocket | Yes | Limited | +| GraphQL query builder | Yes, introspection-driven | Limited | | gRPC | Yes (unary + server streaming) | No | | Functional testing | Yes | Yes | | Load testing | No | Yes | @@ -31,7 +31,7 @@ builds on it with a modern UI and more features. | Mock servers | Yes | Yes (SOAP/REST mocks) | | Export to test code | Robot Framework, Playwright, Karate, REST Assured, supertest | Groovy scripts | | Footprint / UI | Lightweight, modern | Heavier, Java desktop | -| Secrets | AES-256-GCM local + external managers | Properties / project files | +| Secret managers | Vault, AWS, Azure, 1Password (+ AES-256-GCM local) | Properties / project files | ## Where API Spector fits diff --git a/docs/compare/yaak.md b/docs/compare/yaak.md index 9c277c4..f7255a2 100644 --- a/docs/compare/yaak.md +++ b/docs/compare/yaak.md @@ -18,7 +18,9 @@ is a sleek, focused client that has grown quickly. | Local-first / offline | Yes | Yes | | Account required | No | No | | Storage | Files (Git-friendly) | Local, with Git sync | -| Secrets | AES-256-GCM local + Vault/AWS/Azure/1Password | Environment variables | +| Secret managers | Vault, AWS, Azure, 1Password (+ AES-256-GCM local) | Environment variables | +| GraphQL query builder | Yes, introspection-driven | Yes | +| SOAP + WSDL loader | Yes, load a WSDL and generate the envelope | No | | Export to test code | Robot Framework, Playwright, Karate, REST Assured, supertest | Not a focus | | Mock servers | Yes (local and cloud) | No | | Contract testing | Built in, Pact-compatible | No | @@ -27,6 +29,7 @@ is a sleek, focused client that has grown quickly. ## Where API Spector fits +- **Author faster.** An introspection-driven GraphQL query builder, a SOAP WSDL loader that fills in the envelope, and Vault / AWS / Azure / 1Password secret references, all built in - no plugins. - **Beyond the request client.** If your work extends to mocking, contract testing, or generating runnable tests, API Spector includes those. - **Standard test output.** Export to Robot Framework, Playwright, Karate, REST diff --git a/src/renderer/src/components/RequestBuilder/ContractTab.tsx b/src/renderer/src/components/RequestBuilder/ContractTab.tsx index 6a0d06e..2201ffe 100644 --- a/src/renderer/src/components/RequestBuilder/ContractTab.tsx +++ b/src/renderer/src/components/RequestBuilder/ContractTab.tsx @@ -56,10 +56,10 @@ export function ContractTab({ request, onChange }: Props) { return (
- {/* What this tab is — and how it differs from Schema. */} + {/* What this tab is, and how it differs from Schema. */}
- Contract — the published expectation.{' '} - What this request needs from the provider: status, body shape, headers. It becomes the consumer pact used for contract testing (bi-directional verify & can-i-deploy). For a throwaway local response check, use the Schema tab. + Contract.{' '} + What this request expects from the provider: status, headers, and body shape (a JSON Schema). It is checked against the response in the Contract panel and is the consumer side of contract testing (consumer & bi-directional verify), feeding the deploy-check gate. For a quick body check that runs on every send, use the Schema tab.
{/* Status indicator */}