Skip to content
HALOWERK

Codewerk

openapi ts client

Types come from openapi-typescript 7.13.0 (paths, components, operations). On top, a dependency-free client class is generated with one async method per operation (operationId in camelCase, otherwise method + path segments): typed path/query/header parameters, JSON request bodies and a union of the JSON 2xx response types. The complete file is type-checked in memory with the TypeScript 5.9.3 compiler (strict); the result and any diagnostics are returned. Query arrays use form/explode style;.

POST https://code.halowerk.com/v1/openapi-ts-client

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
specSee schemaYesThe API description as a JSON object or as a JSON/YAML string (max. 2 MB). External $ref values are rejected.
client_namestringNoName of the generated client class.
type_checkbooleanNoType-check the generated file with the TypeScript compiler.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "spec"
  ],
  "properties": {
    "spec": {
      "description": "The API description as a JSON object or as a JSON/YAML string (max. 2 MB). External $ref values are rejected.",
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "string",
          "minLength": 2,
          "maxLength": 2000000
        }
      ]
    },
    "client_name": {
      "type": "string",
      "pattern": "^[A-Z][A-Za-z0-9_]{0,63}$",
      "default": "ApiClient",
      "description": "Name of the generated client class."
    },
    "type_check": {
      "type": "boolean",
      "default": true,
      "description": "Type-check the generated file with the TypeScript compiler."
    }
  }
}

Open original schema

Published input example

{
  "spec": {
    "openapi": "3.0.3",
    "info": {
      "title": "Pets",
      "version": "1.0.0"
    },
    "servers": [
      {
        "url": "https://halowerk.com/"
      }
    ],
    "paths": {
      "/pets/{id}": {
        "get": {
          "operationId": "getPet",
          "parameters": [
            {
              "name": "id",
              "in": "path",
              "required": true,
              "schema": {
                "type": "integer"
              }
            }
          ],
          "responses": {
            "200": {
              "description": "The pet",
              "content": {
                "application/json": {
                  "schema": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer"
                      },
                      "name": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’