LAB TOPIC / API DESIGN

API designCreate clear contracts for topic records.

API design connects your vocabulary to the software that uses it. Explore stable IDs, predictable fields, versioning, and explicit failure states. Start with the foundations guide, then compare how different domains adapt the same contract to their own context.

4 CONNECTED ARTICLES

Turn the reading into a consumer agreement

Imagine two teams exchanging topic assignments without sharing the same code. Use the design articles to decide which values both teams must interpret identically: concept identifiers, document revisions, vocabulary releases, and result states. Ask how the receiving team would reconcile a partially successful batch or distinguish a deliberate reclassification from a duplicate request. Document those answers before inventing additional endpoints.

Then review the contract through a change scenario. A display label is corrected, a concept is split, or an input document is replaced. Which change preserves the old assignment, and which needs new evidence? The schema and domain guides offer concrete examples for that discussion. Finish with one readable success record, one valid empty result, and one review case, each paired with the action its consumer should take.

Articles about API design