APIs

Three surfaces, for the interfaces your system exposes.

APIs and the API Catalog

The inventory of interfaces: what the legacy system exposes, and what the modernized one does. As with views and external systems, the legacy side is extracted from the code, and it is worth reading as a description of what is there rather than what was documented.

API Spec

The OpenAPI specification for the modernized application, generated from the code.

Generated specs are staged outside the modernized codebase. That is deliberate: a generated artifact committed into the repository becomes a file people edit by hand, and then it is neither generated nor authored.

API Playground

Calls the API and shows you what comes back, with a Swagger view of the spec. Use it to check an endpoint behaves as the specification says, without a separate HTTP client or a curl command you have to assemble by hand.

What these are not

The API surfaces describe interfaces; they do not verify behaviour. An endpoint that exists, is documented, and returns 200 can still be wrong. The scenarios are what say it is right — see Test runs and reports.