TYPESPEC FOR API FIRST 

La Conf | PARIS | February 28, 2025

model Speaker { role: string; ghUsername: string; bluesky: string; websites: string[]; }

 

const speaker: Speaker = {    
	role: "Lead JavaScript DX | Microsoft Azure",
    ghUsername: "@anfibiacreativa",
    bluesky: "@anfibiacreativa.bsky.social",
    websites: ["https://microfrontend.dev",
    "https://webfragments.dev"],
 };

API-First...

API Spec

Web App

UI Design

microfrontend.dev - @anfibiacreativa

API SPEC

Web App

UI Design

microfrontend.dev - @anfibiacreativa

SPA + cached to CDN

SSG

SSR

Data Request

AT BUILDTIME

Data Request

ON THE FLY

CLIENTS

Data Request

AT RUNTIME

(Containerized) Microservice App.

Serverless Func. (Origin)

Edge Computing/Composable

API Contract and Management, Cache Layer, Validation and Proxy

Homepage

Landing page

Blog page

User page

E-commerce

Hybrid

Simple Object Access Protocol (~1998).

used by XML.

SOAP

RPC

Remote Procedural Calls. Remote subroutines (XML-RPC usa XML) (~1980's)

WebSocket

Full duplex TCP enabling streaming. (~2008)

GraphQL

Open Source data query and manipulation language for API's first developed by Facebook in 2012.

RESTful

Representational State Transfer architecture pattern. (~2000)

With so many architectures, paradigms and patterns....

1

Design and Document

2

Develop

3

Test

An API contracts helps us swap between

- local and remote models

- different languages and orchestrators

- different clients and consumers

microfrontend.dev - @anfibiacreativa

microfrontend.dev - @anfibiacreativa

 API Contract

OpenAPI

(OAS) Open API Spec defines a language agnostic standard for API contracts.

OpenAPI Specification

Where to start

Patterns

Versioning

Spec authoring

Multiple protocols

Diagnostics

API Design challenges

Extensibility

See Playground

Customer Support

API/Model

Language/Framework

Pattern

CHAT BOT

COMPLETIONS/GPT 4O

RAG

TS/LANGCHAIN.JS

Use case and Demo

excluding deployment infrastructure and pipelines

All images: Unsplash or Flaticon.com.

Merci!

@anfibiacreativa

microfrontend.dev

webfragments.dev

typespec.io

TypeSpec for API-First

By Natalia Venditto

TypeSpec for API-First

  • 61

More from Natalia Venditto