PackagesApiReference

api — API Reference

Full API reference for the api package

API reference for the api package.

Functions & Classes

Symbol	Kind	Description
`signatureToSchema()`	function	Maps a TypeScript type signature string to an OpenAPI 3.2 schema object. Han...
`extractSDKTypes()`	function	Extracts SDK-relevant types (interfaces, type aliases, classes, enums) from a...
`generateOpenAPISpec()`	function	Generates a production-quality OpenAPI 3.2 document from the extracted SDK ty...
`buildReference()`	function	Builds a structured API reference from a list of exported symbols. Unlike th...
`generateApi()`	function	Runs the API generation pipeline: walk → extract → generate → write.
`signatureToSchema()`	function	Maps a TypeScript type signature string to an OpenAPI 3.2 schema object. Han...
`extractSDKTypes()`	function	Extracts SDK-relevant types (interfaces, type aliases, classes, enums) from a...
`generateOpenAPISpec()`	function	Generates a production-quality OpenAPI 3.2 document from the extracted SDK ty...
`buildReference()`	function	Builds a structured API reference from a list of exported symbols. Unlike th...
`generateApi()`	function	Runs the API generation pipeline: walk → extract → generate → write.

Types & Interfaces

Symbol	Kind	Description
`SDKProperty`	interface	A single property extracted from an interface or class symbol.
`SDKType`	interface	An SDK type descriptor extracted from the symbol graph.
`ReferenceEntry`	interface	A single entry in the generated API reference.
`SDKProperty`	interface	A single property extracted from an interface or class symbol.
`SDKType`	interface	An SDK type descriptor extracted from the symbol graph.
`ReferenceEntry`	interface	A single entry in the generated API reference.

Other Exports

Symbol	Kind	Description
`tsup.config.ts`	file
`schema-mapper.ts`	file
`sdk-extractor.ts`	file
`openapi.ts`	file
`reference.ts`	file
`index.ts`	file	OpenAPI 3.2 spec generator and structured API reference builder for forge-ts....
`api.test.ts`	file
`schema-mapper.ts`	file
`sdk-extractor.ts`	file
`openapi.ts`	file
`reference.ts`	file
`index.ts`	file	forge-ts/api — OpenAPI spec and API reference generator. Extracts public SDK...
`api.test.ts`	file

api

api package overview

api — Examples

Usage examples for the api package

On this page

Functions & Classes Types & Interfaces Other Exports