From 90aadf0b14aaf836b4f6c5c36fd2fb9ed1808be3 Mon Sep 17 00:00:00 2001
From: thegagne <1399002+thegagne@users.noreply.github.com>
Date: Fri, 5 Sep 2025 08:57:27 -0500
Subject: [PATCH 1/2] docs: improve tooling and ecosystem documentation by
adding list of tools
---
pages/general/tooling-and-ecosystem.md | 56 +++++++++++++++++++++++++-
1 file changed, 54 insertions(+), 2 deletions(-)
diff --git a/pages/general/tooling-and-ecosystem.md b/pages/general/tooling-and-ecosystem.md
index eeac2e1e..8f66d32c 100644
--- a/pages/general/tooling-and-ecosystem.md
+++ b/pages/general/tooling-and-ecosystem.md
@@ -3,6 +3,58 @@
In addition to an API design specification, AEPs also provide an ecosystem of
tooling to help produce and interact with these APIs.
+## Tools
+
+Get started quickly with these essential tools:
+
+**API Definition**
+
+- **[aepc](https://github.com/aep-dev/aepc)** - Generates AEP-compliant RPCs
+from proto messages
+
+**Linting & Validation**
+
+- **[aep-proto-linter](https://github.com/aep-dev/api-linter)** - Lint gRPC
+ definitions for AEP compliance
+- **[aep-openapi-linter](https://github.com/aep-dev/aep-openapi-linter)** -
+ Lint OpenAPI definitions for AEP compliance
+
+**AI**
+
+- **[aep-mcp-server](https://github.com/aep-dev/aep-mcp-server)** - MCP server
+ for AEP-compliant APIs
+- **[aep.dev/llms.txt](https://aep.dev/llms.txt)** - llms.txt for AEP, to
+ provide LLMs with knowledge of AEP guidelines.
+
+**User Interfaces**
+
+- **[aepcli](https://github.com/aep-dev/aepcli)** - Command-line interface for
+ AEP-compliant APIs
+- **[aep-explorer](https://github.com/aep-dev/aep-explorer)** - Interactive web
+ UI for AEP-compliant APIs
+
+**Infrastructure-As-Code and GitOps**
+
+- **[terraform-provider-aep](https://github.com/aep-dev/terraform-provider-aep)** -
+ Terraform provider for AEP-compliant APIs
+- **Kubernetes CRD generator** - Generate Custom Resource Definitions for
+ Kubernetes for AEP-compliant APIs (_Planned_)
+
+**Operations & Governance**
+
+- **API documentation generator** - Planned tool for generating API
+ documentation for AEP-compliant APIs (_Planned_)
+- **Asset inventory tooling** - External integration support for asset
+ inventory and policy management for AEP-compliant APIs (_Planned, External_)
+
+**Community Tools**
+
+We welcome contributions from the community! This section showcases tools built
+by the AEP community that extend or complement the official tooling ecosystem.
+
+- **[aep-typespec](https://github.com/thegagne/aep-typespec)** - Reference
+ implementation using TypeSpec to generate AEP-compliant OpenAPI Schema.
+
## Diagram
The following is a diagram that illustrates an end-to-end workflow, including
@@ -10,7 +62,7 @@ nodes of tooling that exists, or is intended to be created for the project.
Some of the tools in the diagram are not maintained by the AEP project. The
diagram is intended to be a complete representation of tools available to help
-a user understand how the tools fit in to a development workflow.
+a user understand how the tools fit into a development workflow.
```mermaid
flowchart TD
@@ -31,7 +83,7 @@ flowchart TD
hub --> graphql[/GraphQL definitions/]
proto --> proto-service(your proto service)
proto-service --> http-grpc{{"HTTP REST APIs via grpc-gateway"}}
- proto --> proto-linter([aep-proto-linter: lint gRPC definitons for AEP compliance.])
+ proto --> proto-linter([aep-proto-linter: lint gRPC definitions for AEP compliance.])
openapi --> http-generated{{api stubs via openapi-generator}}
openapi --> oas-linter([aep-openapi-linter: lint OAS definitions for AEP compliance.])
http-generated --> http-service(your http service)
From be91d6aebc892c17d1be8ec2296aa2899ee224a6 Mon Sep 17 00:00:00 2001
From: thegagne <1399002+thegagne@users.noreply.github.com>
Date: Mon, 8 Sep 2025 09:12:03 -0500
Subject: [PATCH 2/2] Update pages/general/tooling-and-ecosystem.md
Co-authored-by: Alex Stephen <1325798+rambleraptor@users.noreply.github.com>
---
pages/general/tooling-and-ecosystem.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/pages/general/tooling-and-ecosystem.md b/pages/general/tooling-and-ecosystem.md
index 8f66d32c..c70942a9 100644
--- a/pages/general/tooling-and-ecosystem.md
+++ b/pages/general/tooling-and-ecosystem.md
@@ -7,7 +7,7 @@ tooling to help produce and interact with these APIs.
Get started quickly with these essential tools:
-**API Definition**
+**API Generators**
- **[aepc](https://github.com/aep-dev/aepc)** - Generates AEP-compliant RPCs
from proto messages