-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c16594d
commit fc6d334
Showing
3 changed files
with
30 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,25 @@ | ||
# Adopting AEPs for your company | ||
|
||
By adopting the guidelines from the API Enhancement Proposals, you establish a much | ||
tighter and efficient possibility space. APIs that follow the | ||
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 more consistent within and across teams, reducing cognitive load for API consumers | ||
- reduce arguments about API design decisions, thanks to the AEP specification, tools, and exemplar design patterns | ||
- are more consistent within and across teams, reducing cognitive load for API | ||
consumers | ||
- reduce arguments about API design decisions, thanks to the AEP specification, | ||
tools, and exemplar design patterns | ||
|
||
Having an AEP-compliant API also means benefitting from the AEP ecosystem of tooling, such as: | ||
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]() | ||
- A command line tool interface genreator 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. | ||
- Linters and validators to ensure adherence to the AEP design specification | ||
[proto]()/[openapi]() | ||
- A dynamic command line interface generator 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters