Skip to content

tooling-and-ecosystem.md

Latest commit

 

History

History
91 lines (71 loc) · 3.86 KB

tooling-and-ecosystem.md

File metadata and controls

91 lines (71 loc) · 3.86 KB
Raw

Tooling and Ecosystem

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:

Developer Tools

  • terraform-provider-aep - Terraform provider for AEP-compliant APIs
  • aepcli - Command-line interface for AEP-compliant APIs
  • aep-explorer - Interactive web UI for AEP-compliant APIs
  • aepc - Generates AEP-compliant RPCs from proto messages

Linting & Validation

AI

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 - Reference implementation using TypeSpec to generate AEP-compliant OpenAPI Schema.

Diagram

The following is a diagram that illustrates an end-to-end workflow, including 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 into a development workflow.

flowchart TD
tool([tool])
use-case[/possible use case/]
user(user authored)
generated{{generated}}
Loading

The service generation tooling looks like:

flowchart TD
    resources("AEP Resource yaml")
    resources --> hub(['<a href="https://github.com/aep-dev/aepc">aepc: service API generator</a>'])
    hub --> proto{{"gRPC protobuf definition"}}
    hub --> openapi{{"OpenAPI Schema"}}
    hub --> graphql[/GraphQL definitions/]
    proto --> proto-service(your proto service)
    proto-service --> http-grpc{{"HTTP REST APIs via grpc-gateway"}}
    proto --> proto-linter([<a href="https://github.com/aep-dev/api-linter">aep-proto-linter: lint gRPC definitions for AEP compliance.</a>])
    openapi --> http-generated{{api stubs via openapi-generator}}
    openapi --> oas-linter([<a href="https://github.com/aep-dev/aep-openapi-linter">aep-openapi-linter: lint OAS definitions for AEP compliance.</a>])
    http-generated --> http-service(your http service)
Loading

While the client tooling for an AEP-compliant compatible API includes:

flowchart LR
    http["AEP-compliant REST API and OpenAPI definition"]
    http --> cli([<a href="https://github.com/aep-dev/aepcli">aepcli: a command-line interface for AEP-compliant APIs</a>])
    http --> terraform_generator([<a href="https://github.com/aep-dev/terraform-provider-aep">terraform-provider-aep</a>])
    terraform_generator --> terraform{{"terraform provider for an AEP-compliant API"}}
    http --> mcp([<a href="https://github.com/aep-dev/aep-mcp-server">MCP server, for integrations with LLMs</a>])
    http --> ui([<a href="https://github.com/aep-dev/aep-explorer">aep-explorer: interactive web UI to create, edit, list, and modify resources</a>])
    http --> sdks[/"Language-specific libraries (e.g. via openapi-generator)"/]
    http --> asset_inventory[/"Asset inventory and policy management tooling (external integration)"/]
    http --> crd_generator(["Kubernetes Custom Resource Definitions generator"])
    http --> docs(["API documentation generator (planned)"])
Loading