Wirespec your APIs

What is Wirespec?

Wirespec is a small, human-readable language for describing APIs. You write the contract once, in a .ws file, and it becomes the single source of truth for every team that builds or calls the API:

type Todo {
  id: Integer,
  title: String,
  done: Boolean
}

type ApiError {
  message: String
}

endpoint GetTodo GET /todos/{id: Integer} -> {
  200 -> Todo
  404 -> ApiError
}

From the contract, Wirespec generates typesafe, dependency-free code for each side of the API: TypeScript for the frontend, and Kotlin, Java, Python, Rust or Scala for the backend. It can also publish the contract as OpenAPI or Avro, and turn an existing OpenAPI, AsyncAPI, Avro or GraphQL specification into Wirespec.

Wirespec is built around three ideas, each explained in the documentation:

• Contract first: agree on the interface before anyone implements it, independent of language or framework.
• Generate code: derive models, endpoints and clients from the contract instead of writing them by hand.
• Validate the implementation: test against the same contract with generated test data and mocks.