API startup sequence

Question and use cases

Generated defaults are registered before concrete adapters and readiness guards.

Use this boot flow when adding registrations, readiness guards, schema initialization, or startup work.

Use the diagram during design review, incident diagnosis, code walkthroughs, and onboarding. It intentionally omits classes and projects unrelated to the focused question, so read it together with the source entry point and related topic pages.

This page covers only the named responsibilities and relationships; consult the relevant module documentation for capabilities not shown here.

Reading path

1. Step 1: Separate service registration, host build, guard execution, and middleware startup.
2. Step 2: Observe where generated defaults can be replaced by concrete adapters.
3. Step 3: Follow the init-schema branch separately because it exits before serving requests.

Do not skip arrow direction, numbering, or group titles: they express dependency or time direction, execution order, and responsibility boundaries. If the diagram differs from current source or accepted architecture decisions, correct the generated catalog immediately.

Legend and notation

This is a BOOT FLOW diagram. Use that form to understand the layout, then test your interpretation against the source facts below.

Key relationships and design meaning

Relationship 1

Source fact: Generated services register before runtime defaults and concrete adapters.

Architectural meaning: Generated registration before defaults and adapters creates a predictable override model that can be inspected in one boot sequence.

Review action: Will a missing production dependency fail before the server accepts traffic?

Relationship 2

Source fact: Production configuration and adapter readiness guards run immediately after host build.

Architectural meaning: Readiness guards after host build can resolve the final service graph and fail before traffic reaches an unusable adapter.

Review action: Does registration order select the intended adapter?

Relationship 3

Source fact: --init-schema runs schema initializers and exits without entering the web pipeline.

Architectural meaning: The schema-init exit path lets deployment automation prepare storage without starting a partially initialized web service.

Review action: Can initialization be rerun safely by deployment automation?

Design review questions

Answer each question when reviewing or implementing a related change. If code, tests, or an ADR cannot support the answer, do not decide from the diagram alone.

• Will a missing production dependency fail before the server accepts traffic?
• Does registration order select the intended adapter?
• Can initialization be rerun safely by deployment automation?

How to use the answers

1. Identify the single owner of the capability or rule.
2. Confirm that dependency, call, or event direction does not reverse ownership.
3. Capture the conclusion with an automated test or repeatable command.

Boundaries and common mistakes

Boundary 1

Registration order controls which default or concrete implementation wins.

• Do not infer: A connector in the diagram does not mean every implementation uses synchronous calls, a shared transaction, or shared data ownership.
• Review requirement: Does registration order select the intended adapter?

Boundary 2

Keep middleware order visible in Program.cs; do not hide it behind a broad extension method.

• Do not infer: A connector in the diagram does not mean every implementation uses synchronous calls, a shared transaction, or shared data ownership.
• Review requirement: Can initialization be rerun safely by deployment automation?

Source verification and regeneration

The primary verification entry point is src/Hosts/BitzOrcas.Api/Program.cs. Inspect it and its direct references before regenerating diagram assets and pages.

# Regenerate bilingual SVG, standalone HTML, and documentation pages
npm run diagrams

# Check locale pairs, references, safety attributes, accessibility, and canvas bounds
npm run verify:diagrams

# Confirm that generation changed only the intended diagrams and pages
git diff -- scripts/diagrams diagram-sources public/diagrams src/content/docs

# Verify internal links, MDX structure, and professional depth gates
npm run verify:docs
npm run audit:docs-depth

Change-completion checklist

• Responsibilities, order, states, and relationships match current source.
• Every new element helps answer this page’s question instead of turning the diagram into an inventory.
• Arrows have explicit direction and semantics without implying nonexistent synchronous or transactional guarantees.
• Chinese and English titles, labels, facts, and boundaries remain semantically equivalent.
• The diagram remains readable on narrow screens, in fullscreen, and while zoomed, with no overlap or overflow.
• Relevant architecture tests, integration tests, or verification commands have run.
• If a long-lived constraint changed, its ADR or architecture documentation is updated.

Continue reading

• Architecture overview
• All architecture diagrams
• Platform modules