Pact JVM VS spec

API Contract Testing might be worth exploring. Gives you the ability to run it quickly locally or in CI/CD. A centralized way to validate if your changes broke another service might also be interesting. That series of videos from the same team is gold: https://docs.pact.io

We use Pact for contract testing https://docs.pact.io/

The introduction here is quite good: https://docs.pact.io/

Pact.Net documentation: https://docs.pact.io/ Mountebank documentation: http://www.mbtest.org/ The Microsoft.AspNetCore.TestHost package on GitHub: https://github.com/aspnet/AspNetCore/tree/main/src/Testing/Microsoft.AspNetCore.TestHost

There's also https://docs.pact.io/ but I haven't had time yet to really look into it but probably someone else can tell something about it.

This PoC shows a step by step implementation of contract testing using Pact.

Contract tests assert that inter-application messages conform to a shared understanding documented in a contract. Without contract testing, the only way to ensure that applications will work correctly together is by using expensive and brittle integration tests.

If you are updating your API based on user feedback, you can work with your team or stakeholders to build an API contract describing how your API should function. You can use JSON schemas to document your API’s endpoint response codes and set up the contract. The contract must be accepted by all parties. Then, any changes made to the API must pass the contract test before being approved. Contract testing can be automated and incorporated into your CI/CD pipeline. Contract testing tools include Pact and Spring Cloud Contract.

Pact.

I have contract tests (https://docs.pact.io/) to ensure the integration works.

AsyncAPI: Interested in how to define your WebSocket APIs? One of the most advanced realtime specifications is the AsyncAPI specification, which comes with various generators for code and documentation, as well as renderers for the specifications.

Our journey with FastStream started when we needed to integrate our machine learning models into a customer's Apache Kafka environment. To streamline this process, we created FastKafka using AIOKafka, AsyncAPI, and asyncio. It was our first step in making message queue management easier.

Automatic Docs: Stay ahead with automatic AsyncAPI documentation

FastStream supports in-memory testing, AsyncAPI schema generation and more... If you are interested, please support our project by giving a GH start and joining our discord server.

However, in order for the system to work effectively, there must be a common understanding between the components regarding events and their data structures. This is where AsyncAPI comes in; it helps define a contract that describes how the components communicate and behave effectively.

You can also take a look at https://www.asyncapi.com/ (a spec for asynchronous APIs). It's useful for this use case, that is, building a well structured websocket interface with pub/sub.

Sure! Next step I am working on AsyncAPI scheme generation by your application code. It's also includes a project generation from scheme, scheme web view (lika the Swagger for OpanAPI), etc. It will a much difficult than just another broker implementation...

Onboarding - Enable developers to quickly learn how to consume the exposed APIs. For example, offer OpenAPI or AsyncAPI documentation and provide a portal and sandbox.