Apidays New York 2024 - Scaling API-first by Ian Reasor and Radu Cotescu, Adobe

Scaling API-first – The story of a global engineering organization
Ian Reasor, Senior Computer Scientist - Adobe
Radu Cotescu, Senior Computer Scientist - Adobe

Apidays New York 2024: The API Economy in the AI Era (April 30 & May 1, 2024)

------

Check out our conferences at https://www.apidays.global/

Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8

Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io

Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/

1. May 1st, 2024
Scaling API-first – The story of a
global engineering organization
Ian Reasor | Senior Computer Scientist
Radu Cotescu | Senior Computer Scientist

3. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
Who We Are
Adobe Experience Manager
Best In Class Content Management, Digital Asset Management and Forms Processing Platform
Ian Reasor
Senior Computer Scientist
AEM Assets
Radu Cotescu
Senior Computer Scientist
AEM Sites

4. Our Journey
© 2024 Adobe. All Rights Reserved.
May 1st, 2024

5. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
API First Task Force
“Organizations which design systems… are constrained to produce designs which are copies of the
communication structures of these organizations.”
—Melvin E. Conway, How Do Committees Invent?
© 2024 Adobe. All Rights Reserved.

6. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
API First Task Force
Discuss standards
Document API guidelines
Review new APIs
Build tooling
Provide infrastructure

7. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
JSON Schema conventions API style guide
Pagination and sorting Security
Long-running operations Performance
Conditional requests Error handling
Versioning API namespace
API First Guidelines

8. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
API First Guidelines - Standards
RFC 2119
Key words for use in RFCs to
Indicate Requirements Levels
RFC 9110
HTTP Semantics
RFC 5789
PATCH method for HTTP
RFC 6902
JSON Patch
RFC 7396 JSON Merge Patch
RFC 7807 Problem Details for HTTP APIs
RFC 8594 The Sunset HTTP Header Field
RFC 9111HTTP Caching RFC 6585 Additional HTTP Status Codes

9. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
Common OpenAPI Schemas Repository
├── headers
│ ├── request
│ │ ├── If-Match.yaml
│ │ ├── If-None-Match.yaml
│ └── response
│ ├── ETag.yaml
│ ├── Last-Modified.yaml
│ ├── Location.yaml
│ └── Retry-After.yaml
├── parameters
│ ├── cursor.yaml
│ └── limit.yaml
├── responses
│ ├── 204_NoContent.yaml
│ ├── …
│ ├── 503_ServiceUnavailable.yaml
│ ├── ProblemDetails.yaml
│ ├── CommandResult.yaml
└── schemas
├── Cursor.yaml
├── Limit.yaml
├── OrderBy.yaml
└── jsonpatch
├── AddOperation.yaml
├── ...

10. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
Common OpenAPI Schemas Repository

11. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
Redocly Decorators

12. Redocly Decorators
Authentication
Add authentication methods for use in local
development workflows
Code Generation
Generate code, based on custom business rules
Add Servers
Add additional servers to support development
workflows
Add Parameters
Add additional parameters, such as those used
in development workflows or those that are only
available in certain deployment scenarios.
© 2024 Adobe. All Rights Reserved.
May 1st, 2024

13. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
API Schema Bootstrap

14. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
Validates
•Alignment to security best practices
•No introduction of new vulnerabilities
Validates •Adherence to API Guidelines
•Coherence with APIs from other product areas
API Reviews
Validates
•Correctness of API for the business case
•Coherence with other APIs in the product area
Objective Outsider
API expert from outside of the team
Security Champion
Member of the security team
Subject Matter Expert
Member of the implementing team

15. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
API Registry and Router
§Developers release new API versions to our
artifact repository and list them in the API registry
•CI reads the updated registry configurations and
builds and deploys a set of API router VCL
configurations in our CDN
•Client requests are routed to the appropriate
backends by the router

16. © 2024 Adobe. All Rights Reserved.
May 1st, 2024
Developer Documentation
https://developer.adobe.com/experience-cloud/experience-manager-apis/

17. Looking Back
© 2024 Adobe. All Rights Reserved.
May 1st, 2024