Shared API Client

Shared API Client Overview

At its core, shared api client is about doing one thing well inside your single-spa project. Once you understand the pattern, you can apply it consistently across features and teams.

Good shared api client pays off across the whole codebase: fewer surprises, easier testing, and smoother onboarding. The snippet below is a solid starting point.

// shared utility module exposed via the import map
export const authService = {
  getToken: () => localStorage.getItem('token'),
};

// consumed by any micro frontend
import { authService } from '@org/utils';

Shared utility modules provide cross-app services like auth without tight coupling.

Shared API Client Example

registerApplication({
  name: '@org/app',
  app: () => System.import('@org/app'),
  activeWhen: ['/app'],
});
start();

• Start from a minimal Shared API Client example and grow it only as needed.
• Keep configuration explicit so Shared API Client behaves the same in every environment.
• Name things clearly so teammates understand your Shared API Client at a glance.
• Add tests around Shared API Client early to lock in expected behaviour.

Single-SPA Cheatsheet

Core single-spa APIs related to shared api client.

How Shared API Client Works in Single-SPA

Shared API Client is part of how single-spa lets multiple applications — even in different frameworks — coexist on one page. A root config registers each app and controls when it is active.

Shared utility modules provide cross-app services like auth without tight coupling.

• A root config registers apps and calls start().
• Each app exports bootstrap, mount, and unmount lifecycles.
• activeWhen decides which routes each app owns.
• Import maps resolve each app's bundle at runtime.

Practical Guidance for Shared API Client

For reliable micro frontends, shared api client should isolate failures and keep shared state minimal. Let each team own its app end to end while agreeing on a few shared contracts.

Common Mistakes

• Copying shared api client snippets without understanding what each line does.
• Skipping error handling and edge cases when wiring up shared api client.
• Leaving shared api client untested, so regressions slip into production.
• Over-engineering shared api client before you actually need the extra flexibility.

Key Takeaways

• Shared API Client is a core part of working effectively with single-spa.
• Start small and keep shared api client focused on a single responsibility.
• Apply consistent patterns so shared api client scales across your project.
• Test and document shared api client to keep it maintainable over time.