API Endpoint and Serializer Authoring FAQs

Question 1

What is the difference between a resource and an action endpoint?

Accepted Answer

Resource endpoints represent existing objects and return a 409 status if a required product is missing, while action endpoints are advisory and return a 200 status with a capability envelope.

Question 2

How does this skill handle pagination?

Accepted Answer

It implements cursor-based pagination using Base64 encoded metadata, which ensures result stability against concurrent data inserts compared to traditional offset pagination.

Question 3

What changed in Phase 6 for serializers?

Accepted Answer

Post-Phase 6, read tools use Strawberry types for GraphQL API extensions, meaning serializers are now primarily reserved for mutation acknowledgments.

Question 4

How do I fix the test_resource_route_coverage CI gate?

Accepted Answer

Ensure the read tool has a registered FastAPI route. If the naming convention is non-standard, you must add a mapping to the TOOL_ROUTE_OVERRIDES dict in the test file.

Question 5

Are there specific dependency rules for apps/api?

Accepted Answer

Yes, apps/api must only import from unifi-core. Importing unifi-mcp-shared within the API layer is strictly prohibited to prevent coupling REST and MCP protocols.

API Endpoint and Serializer Authoring

Key Features

Use Cases

REST API Design Patterns

Qa Javascript Typescript

Bun Runtime Optimizer