OpenAPI enables developers to define APIs in a consistent format, facilitating integration and documentation. It promotes interoperability between different systems and ensures better communication within the API ecosystem.
Use this profile to understand the building block briefly, place it in the model, and switch to the 360° assessment when needed.
Technical building block: can be automated, integrated, or operated.
Concrete cog in the system that works inside larger relationships.
OpenAPI is a standardized format for describing HTTP APIs in a machine-readable way and sharing them across teams and toolchains.
OpenAPI refers to the standard family that grew from the Swagger specification, donated to the OpenAPI Initiative in 2015. It continued as an open, vendor-neutral approach to describing APIs.
An OpenAPI description defines paths, operations, parameters, request and response schemas, and security requirements. The same description can drive documentation, mocking, tests, or clients. It is a contract; it does not implement the service automatically and only helps when it matches actual behavior.
Paths, operations, and data models make the expected API surface explicit.
Providers and consumers can refer to shared, machine-readable behavior.
Documentation, mocking, validation, and code generation can reuse one description.
OpenAPI improves clarity and coordination in API development. Teams still need decisions about versioning, compatibility, security details, and keeping the specification aligned with implementation.
Where this building block is located in the topic model.
Explore how this building block connects to concepts, methods, technologies, and tools.
These sources establish the term and its professional meaning.
All direct connections of the current building block in a compact text view.
This classification shows where the building block typically matters, how demanding it is, and what kind of impact it has in the model.
The level within the organization (enterprise, domain, team) at which the AssetBlock is applied.