How looker-open-source/sdk-codegen works
This repository combines a generator for Looker API client SDKs with the generated SDKs, API Explorer, and RunIt REST client tester. The primary workflow is configuring a Looker server, obtaining and converting its API specification, validating it, then generating language bindings. Separately, API Explorer presents API references and differences, while RunIt lets users try REST calls. SDK runtime modules handle settings, authentication, and transport; the sampled TypeScript runtime shows browser service construction and transport responsibilities. Several branches are documented in the README but their implementation details were not sampled, so those links cite the README.
Main entry points: codeGen.ts Code generator · AppRouter.tsx Explorer routes · transport.ts HTTP transport · ApiExplorer.tsx Explorer app
Components 21
SDK generation
- API specification
- Code generator
packages/sdk-codegen/src/codeGen.ts - Spec conversion
packages/sdk-codegen-scripts/src/convert.apispec.ts - Resource index
bin/looker-resources-index/src/resource-data/resources.ts
SDK clients
- TypeScript SDK
packages/sdk/src/4.0/funcs.ts - Python SDK
python/looker_sdk/rtl/auth_session.py - C# SDK
csharp/sdk/4.0/methods.cs - Go SDK
go/sdk/v4/methods.go
API Explorer
- Explorer app
packages/api-explorer/src/ApiExplorer.tsx - Explorer routes
packages/api-explorer/src/routes/AppRouter.tsx - Method reference
packages/api-explorer/src/scenes/MethodScene/MethodScene.tsx - Type reference
packages/api-explorer/src/scenes/TypeScene/TypeScene.tsx - Spec differences
packages/api-explorer/src/scenes/DiffScene/DiffScene.tsx - REST tester
packages/run-it/src/RunIt.tsx
SDK runtime
- API settings
packages/sdk-rtl/src/apiSettings.ts - Auth session
python/looker_sdk/rtl/auth_session.py - HTTP transport
packages/sdk-rtl/src/transport.ts - Browser services
packages/sdk-rtl/src/browserServices.ts - Browser transport
packages/sdk-rtl/src/browserTransport.ts
Other components
- SDK developer
- Looker server
Connections 19
- SDK developer → Code generator: runs generation
- SDK developer → Looker server: configures access
- Looker server → API specification: provides spec
- API specification → Spec conversion: converts format
- Spec conversion → Code generator: supplies converted spec
- Code generator → TypeScript SDK: generates bindings
- Code generator → Python SDK: generates bindings
- Code generator → C# SDK: generates bindings
- Code generator → Go SDK: generates bindings
- Explorer app → Explorer routes: uses routes
- Explorer routes → Method reference: routes to
packages/api-explorer/src/routes/AppRouter.tsx - Explorer routes → Type reference: routes to
packages/api-explorer/src/routes/AppRouter.tsx - Explorer routes → Spec differences: routes to
packages/api-explorer/src/routes/AppRouter.tsx - Explorer app → REST tester: embeds tester
- API settings → HTTP transport: configures
packages/sdk-rtl/src/apiSettings.ts - Browser services → API settings: uses settings
packages/sdk-rtl/src/browserServices.ts - Browser services → Browser transport: constructs transport
packages/sdk-rtl/src/browserServices.ts - Browser transport → HTTP transport: implements contract
- Auth session → HTTP transport: uses transport
python/looker_sdk/rtl/auth_session.py