Skip to content

Sample: typespec-first-development - TypeSpec-first API workflow with LLM #35

@waldekmastykarz

Description

@waldekmastykarz

Summary

Create a sample demonstrating TypeSpec-first API development workflow with Dev Proxy.

Plugins to use

  • TypeSpecGeneratorPlugin - generates TypeSpec from traffic
  • Local language model configuration for better descriptions

What to build

  • Generate TypeSpec from existing API traffic
  • Show improved results when using local LLM
  • Complete workflow:
    1. Record API traffic → TypeSpec
    2. TypeSpec → OpenAPI
    3. OpenAPI → Client SDKs
  • Compare TypeSpec output with and without LLM

Without LLM

op operation1(): string;

With LLM

@doc("Retrieves a list of all customers")
op getCustomers(): Customer[];

Why this is compelling

Modern API-first workflow. Better starting point for API design with AI-enhanced descriptions.

Reference docs

  • TypeSpecGeneratorPlugin technical reference
  • Generate TypeSpec file how-to guide
  • Use a local language model how-to guide

Metadata

Metadata

Labels

No labels
No labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions