Application and Integration Architecture
Document your application portfolio, service interactions, and integration patterns. This area covers how systems connect and communicate.
The Application and Integration Architecture directory is where you document your software systems, their components, and how they interact with each other and external services.
What Belongs Here
This directory is the home for documentation about your application landscape and the connections between systems:
Recommended Content Blocks
When documenting application and integration architecture, these content blocks are particularly useful:
| Block Type | Use For |
|---|---|
| Diagram | C4 context and container diagrams, integration flow diagrams, service dependency maps |
| REST API Endpoint | Embedding live API documentation from your REST API definitions |
| Schema Definition | Embedding request/response schemas and data contracts |
| Component Responsibility | Defining service boundaries and ownership |
| Graph Diagram | Force-directed service dependency visualisations |
| Assumption | Recording integration assumptions about external systems |
| Constraint | Documenting API rate limits, protocol requirements, and vendor limitations |
Diagram Types
Several diagram styles are well-suited to application and integration documentation:
Example Directory Structure
application-and-integration-architecture/
├── application-portfolio/
│ ├── customer-portal.cf.page.json
│ ├── order-management.cf.page.json
│ └── inventory-service.cf.page.json
├── integration-patterns/
│ ├── event-driven-architecture.cf.page.json
│ ├── api-gateway-patterns.cf.page.json
│ └── message-queue-standards.cf.page.json
├── external-integrations/
│ ├── payment-gateway.cf.page.json
│ ├── shipping-providers.cf.page.json
│ └── crm-integration.cf.page.json
└── api-standards/
├── rest-api-guidelines.cf.page.json
└── versioning-strategy.cf.page.jsonLearn more
Create application architecture diagrams showing internal structure, layers, components, and dependencies within an application.
Create integration architecture and event-driven architecture diagrams showing how systems connect, exchange data, and handle events.
Create microservices and API architecture diagrams showing independent services, API gateways, and service interactions.
Create C4 Model diagrams including System Context, Container, Component, and Deployment views using NeoArc Studio's diagram editor.
Document REST APIs with full endpoint specifications, OpenAPI import and export, seven HTTP methods, parameters, request and response bodies linked to shared schemas, authentication schemes, and a published API browser. REST is part of the API documentation suite (REST, GraphQL, gRPC, AsyncAPI, Webhooks, MCP) sharing a unified schema layer.