September 28-29, 2021
View More Details & Registration

The Sched app allows you to build your schedule but is not a substitute for your event registration. You must be registered for API Specifications Conference to participate in the sessions. If you have not registered but would like to join us, please go to the event registration page to purchase a registration.

This schedule is automatically displayed in Pacific Daylight Time (UTC -7). To see the schedule in your preferred timezone, please select from the drop-down menu to the right, above "Filter by Date." The schedule is subject to change.
Back To Schedule
Tuesday, September 28 • 10:50am - 11:20am
We brought OpenAPI Docs into our service catalog. Now what? - Shai Sachs & Zoe Song, Wayfair

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

Feedback form is now closed.
With a large, globally distributed engineering department of over 2,000 engineers, service discoverability and access to API documentation are important problems at Wayfair. Integrations between systems require close coordination and overhead, making these kinds of projects expensive and brittle. To address this problem, we sought to surface OpenAPI documentation in our Backstage Service Catalog.

We will discuss how over 175 API specifications are shared amongst teams at Wayfair. Our solution leverages the Kubernetes API, together with our home-grown tool for project generation, to programmatically surface OpenAPI files for inspection in Backstage. Backstage is a service catalog and developer portal recently released as open source by Spotify. Our work has had immediate service discoverability benefits for developers across our enterprise, with thousands of API doc page views since it launched. Of course, our work is never complete! As the solution rolled out, we discovered a lot of complexity in the space of surfacing API docs. We’ll discuss some of the problems we’ve encountered, as well as the solutions we’re trying, along the way. These problems include: whether to support code-first or schema-first development; how to store API schemas; and how to enforce versioning as part of the CI/CD pipeline. At the end of the talk, we want the audience to have a good understanding of the benefits of service discoverability, as well as the trade-offs inherent in making API specs discoverable.


Zoe Song

avatar for Shai Sachs

Shai Sachs

Staff engineer at Wayfair, Cloud Native Team, Wayfair
Shai Sachs is a staff engineer on Wayfair's Service-to-Service enablement team. His recent projects include standing up Wayfair's enterprise API gateway, and building a governance layer for Wayfair microservices. Previously, he worked as the Innovation Platform Director at EveryA... Read More →

Tuesday September 28, 2021 10:50am - 11:20am PDT
Virtual Experience
  • Slides Attached Yes