Service Catalog
Every service, API endpoint, and database automatically documented. Generated from your TypeScript or Go types, always current.
Documentation that writes itself
Encore extracts types directly from your code. Request and response schemas, endpoint descriptions, and service dependencies are always accurate.
- ✓Type extraction from code
- ✓Interactive API explorer
- ✓Request/response examples
- ✓Service dependency map
Type extraction
Request/response types, nested objects, enums, and unions extracted directly from your source code. Full type information without manual annotation.
API explorer
Test endpoints from the browser with auto-generated forms based on your types. Works locally and in cloud environments.
Always accurate
Documentation updates when code changes. Change an API parameter, the docs update automatically. No manual sync required.
Types become documentation
Define your API with TypeScript interfaces. Encore extracts type information, validates requests at runtime, and generates documentation including nested types, unions, and optionals.
Includes authentication requirements, path parameters, query strings, headers, and response types. All extracted automatically from your code.
interface CreateUserRequest {
email: string;
name: string;
role: "admin" | "member";
}
interface User {
id: string;
email: string;
name: string;
createdAt: string;
}
export const createUser = api(
{ method: "POST", path: "/users", auth: true },
async (req: CreateUserRequest): Promise<User> => {
// ...
}
);API documentation at a glance
The service catalog gives you a complete map of your APIs and services, from high-level architecture down to individual field types.
Services
All your services listed with their endpoints and dependencies
API Endpoints
Every endpoint with method, path, request/response types, and auth requirements
Type Definitions
Full type information extracted from TypeScript or Go, including nested objects
Service Dependencies
Which services call which, visualized in the architecture diagram
Auth Requirements
See which endpoints require authentication at a glance
API Explorer
Test any endpoint directly from the catalog with type-aware forms
Test APIs without Postman
The service catalog includes an API explorer that lets you call any endpoint directly from the browser. Request parameters are pre-filled based on your type definitions, and responses are formatted for readability.
- ✓Auto-generated request forms from your types
- ✓Works for local dev and cloud environments
- ✓Authentication tokens handled automatically
Architecture diagrams included
Encore generates architecture diagrams showing how your services connect, which databases they use, and how messages flow through pub/sub topics. The diagrams update automatically as your code changes.
Learn more →
