Skip to content

getting-started.md

Latest commit

 

History

History
164 lines (122 loc) · 4.11 KB

getting-started.md

File metadata and controls

164 lines (122 loc) · 4.11 KB

Getting Started with LAP

Installation

Python SDK

pip install lapsh

# Or from source:
git clone https://github.com/Lap-Platform/lap.git
cd lap
pip install -r requirements.txt

Dependencies: pyyaml, tiktoken, rich

Optional extras:

pip install lapsh[langchain]   # LangChain integration
pip install lapsh[tokens]      # Token counting with tiktoken

TypeScript SDK

# Use directly (no install)
npx @lap-platform/lapsh compile api.yaml -o api.lap

# Or install globally
npm install -g @lap-platform/lapsh

# Or add to a project
npm install @lap-platform/lapsh

CLI Only

If you just need the compiler:

git clone https://github.com/Lap-Platform/lap.git
cd lap
pip install pyyaml tiktoken rich
lapsh --help

Quick Start: Compile Your First API in 60 Seconds

1. Compile an OpenAPI spec

lapsh compile examples/verbose/openapi/stripe-charges.yaml -o stripe.lap

Output:

✓ Compiled stripe-charges.yaml → stripe.lap
✓ 5 endpoints | 4,291 chars | standard mode

2. See the result

The compiled LAP file:

@lap v0.1
@api Stripe Charges API
@base https://api.stripe.com
@version 2024-12-18
@auth Bearer bearer

@endpoint POST /v1/charges
@desc Create a charge
@required {amount: int # Amount in cents., currency: str # ISO 4217 code.}
@optional {source: str, customer: str, description: str, metadata: map, ...}
@returns(200) {id: str, amount: int, currency: str, status: str, paid: bool, ...}
@errors {400: Invalid request., 401: Auth failed., 402: Card declined., 429: Rate limited.}

3. Try lean mode for maximum compression

lapsh compile examples/verbose/openapi/stripe-charges.yaml --lean

Output (lean mode strips descriptions):

@lap v0.1
@api Stripe Charges API
@base https://api.stripe.com
@version 2024-12-18
@auth Bearer bearer

@endpoint POST /v1/charges
@required {amount: int, currency: str}
@optional {source: str, customer: str, description: str, metadata: map, ...}
@returns(200) {id: str, amount: int, currency: str, status: str, paid: bool, ...}
@errors {400, 401, 402, 429}

4. Inspect the compiled output

lapsh inspect stripe.lap

Understanding LAP Output

LAP is a structured, typed format for API documentation. Here's what each directive means:

Header Directives

Directive Purpose Example
@lap Format version @lap v0.1
@api API name @api Stripe Charges API
@base Base URL @base https://api.stripe.com
@version API version @version 2024-12-18
@auth Auth scheme @auth Bearer bearer

Endpoint Directives

Directive Purpose Example
@endpoint Method + path @endpoint POST /v1/charges
@desc Description @desc Create a charge
@required Required params @required {amount: int, currency: str}
@optional Optional params @optional {limit: int=10}
@returns(N) Response schema @returns(200) {id: str, status: str}
@errors Error codes @errors {400, 401, 429}

Type System

Type Meaning Example
str String name: str
int Integer amount: int
num Number (float) price: num
bool Boolean active: bool
map Object/dict metadata: map
any Any type data: any
[type] Array tags: [str]
type? Nullable email: str?
type(format) Format hint created: int(unix-timestamp)
enum(a|b|c) Enumeration status: enum(active|inactive)
type=default Default value limit: int=10

Standard vs Lean

  • Standard mode — keeps @desc and # comment annotations. Best for debugging and human review.
  • Lean mode (--lean) — strips all descriptions. Maximum compression for production agent use.

Next Steps