OpenAPI Specification
The echoValue API is fully documented using the OpenAPI 3.0 specification format.
Download
Section titled “Download”View & Test Interactively
Section titled “View & Test Interactively”Swagger UI: Open in Swagger UI
Use Cases
Section titled “Use Cases”Generate Client SDKs
Section titled “Generate Client SDKs”Use OpenAPI Generator to generate client libraries:
openapi-generator-cli generate \ -i https://docs.echovalue.dev/openapi.yaml \ -g javascript \ -o ./echovalue-clientSupported languages include Java, Ruby, PHP, C#, TypeScript, Rust, and many more.
Import into API Tools
Section titled “Import into API Tools”| Tool | Steps |
|---|---|
| Postman | File → Import → Link → Paste OpenAPI URL |
| Insomnia | Create → Import From → URL → Paste OpenAPI URL |
| Paw | File → Import → Paste OpenAPI URL |
| HTTPie | Import → OpenAPI → Paste OpenAPI URL |
API Validation in Tests
Section titled “API Validation in Tests”// Example with jest-openapiconst jestOpenAPI = require('jest-openapi');jestOpenAPI('https://docs.echovalue.dev/openapi.yaml');
test('GET /default/mykey returns valid response', async () => { const response = await fetch('https://api.echovalue.dev/kv/default/mykey', { headers: { 'x-token': 'mytoken' } }); expect(response).toSatisfyApiSpec();});Mock Server
Section titled “Mock Server”# Using Prismnpx @stoplight/prism-cli mock \ https://docs.echovalue.dev/openapi.yaml
# Mock server runs at http://127.0.0.1:4010The OpenAPI specification is automatically updated with each documentation release. Always use the latest version from: