A GitHub repository dedicated to supporting producing or consuming an API.
GitHubRepository
Experiences
Provenance
I keep shining a light on provenance because nobody talks about it enough. Where did this data come from? How has this resource evolved? Without tracking the source and history of your API resource...
Quality
I see the quality of APIs eroding across the landscape. Teams ship fast and never look back, but consumers feel every rough edge, every missing example, every inconsistent response. Quality is what...
Workspaces
Workspaces are one of those building blocks that quietly change everything. Having a dedicated place where teams can collaborate on API design, testing, and operations makes the whole lifecycle mor...
Collaboration
I see teams producing and consuming APIs in complete silos, with no shared visibility into designs, changes, or decisions. Collaboration isn't just a nice-to-have -- it's a building block that prev...
Policies
GitHub Organization Repositories
Repositories within a GitHub organization let you separate and organize API contracts by bounded context. This is how you keep things manageable as the number of APIs grows within a domain.
GitHub Repository
The GitHub repository is the single source of truth for an API contract. OpenAPI, road map, change log, support -- everything lives here, and it is where the real work of producing APIs happens.
Certifications
Certifications provide a formal record that an API contract has been reviewed and meets specific standards. This is how you build confidence that governance is not just theoretical.
Issues
Git issues create a paper trail of the conversations, decisions, and changes around an API contract. This provenance is valuable for auditing and understanding how an API got to where it is.
Pull Requests
Pull requests are where the actual changes to business and technical artifacts happen. They create a reviewable, traceable record of every modification to the API contract.
Reviews
Governance reviews create a formal record of whether an API contract meets the standards. This is how you track compliance over time and build accountability into the process.
Provenance
Provenance is the story of how an API contract evolved over time. The reviews, validations, certifications, and conversations all contribute to a record that builds trust and supports auditing.
Issues
Issues are how you communicate about API change and collect feedback in the open. They tie conversations directly to the repository where the actual artifacts live.
Pull Requests
Pull requests are the mechanism for submitting changes to business and technical artifacts. They create a reviewable, approvable workflow that keeps the source of truth clean.
README
A README in each API contract repository is the front door for anyone landing there. It should tell you what the API is, how to find the contract, and where to get started.