Skip to content

Commit

Permalink
Stubbing out the aep tooling list
Browse files Browse the repository at this point in the history
will update links after #231 is addressed
  • Loading branch information
earth2marsh authored Nov 2, 2024
1 parent 5631df6 commit 84f52c5
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions pages/general/adopting.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# Adopting AEPs for your company

Currently, we encourage adoption of AEPs via having your APIs adhere to the
guidance served at https://aep.dev.
By adopting the guidelines from the API Enhancement Proposals, you establish a much
tighter and efficient possibility space. APIs that follow the
[AEP guidance](https://aep.dev) from the design stage are:

In the future, we plan to introduce a broader ecosystem of tooling including:
- More consistent APIs within and across teams, reducing cognitive load for consumers
- Argue less about API design decisions, saving time thanks to AEPs explar design patterns

- A forkable repository which allows for internal mirrors and
organization-specific guidance.
- Client-side and server-side code generators.
- Validators to ensure adherence to the specification.
Having an AEP-compliant API also means benefitting from the AEP ecosystem of tooling, such as:

- Linters and validators to ensure adherence to the AEP design specification [proto]()/[openapi]()
- Command line tool that make it easier to work with APIs ([aepcli](https://github.com/aep-dev/aepcli))
- Client-side and server-side code generators ([aepc](https://github.com/aep-dev/aepc))
- A Terraform provider ([terraform-provider-aep](https://github.com/aep-dev/terraform-provider-aep))
- ... and more! Please start a [discussion](https://github.com/aep-dev/aep.dev/discussions) if there is something you wish to see, validate, or prioritize.

0 comments on commit 84f52c5

Please sign in to comment.