API docs
Every API of the catalog. HTTP contracts open in Swagger UI; the event contract of the order workflow (AsyncAPI) opens as its own page.
Every API of the catalog. An HTTP API opens in Swagger UI on its contract; the order workflow events open on a page of their own, Swagger UI not reading AsyncAPI. The Bank Partner is one of them: its contract lives in contracts/ like the others.
mock opens the contract mock of an OpenAPI contract: Prism serves every file of contracts/ from its schemas and examples, checks each request against the contract (a missing parameter answers 422, a missing key 401), and needs nothing written beside the contract. All of them listed at http://localhost:4010. The captured Bank Partner examples stay in Microcks, which picks the answer by request: the tests use Microcks, see Recorded examples.
-
📘
Bank Partner API
openapi partners-squad
The balance of an account, as the partner publishes it.
🎠mock http://localhost:4010/bank-partner/ -
📘
Gherkin runner API
openapi qa-web
Runs a feature or a scenario and reports its verdict.
🎠mock http://localhost:4010/gherkin-runner/ -
📘
Identity API
openapi identity-squad
Sign-up, sign-in, password reset and management tickets.
🎠mock http://localhost:4010/identity/ -
📘
Newsletter API
openapi storefront-squad
The newsletters of a customer, generated by FastAPI.
🎠mock http://localhost:4010/newsletter/ -
📨
Order workflow events
asyncapi checkout-squad
The thin events that drive an order from one step to the next.
-
📘
Storefront API
openapi storefront-squad
Greeting, products and orders, generated by FastAPI.
🎠mock http://localhost:4010/storefront/