OpenAPI Specification

The echoValue API is fully documented using the OpenAPI 3.0 specification format.

Download

Download the latest spec here: openapi.yaml

View & Test Interactively

Use Cases

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-client

Supported languages include Java, Ruby, PHP, C#, TypeScript, Rust, and many more.

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

// Example with jest-openapi
const 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

npx @stoplight/prism-cli mock \
  https://docs.echovalue.dev/openapi.yaml

# Runs at http://127.0.0.1:4010

Notes

The OpenAPI specification is updated alongside documentation releases.
Always use https://docs.echovalue.dev/openapi.yaml for the latest published version.