Jump to content

Platform Engineering Team/API Value Stream

From mediawiki.org
Revision as of 21:49, 7 December 2021 by NNikkhoui (WMF) (talk | contribs) (→‎Artifacts: add section and link to notes)

Mission / Objective

Responsible API governance, development frameworks and guidance

API Platform Value Stream Demo

On a regular cadence, the Api Platform Value Stream team will post demos of our developments/works in progress here to provide transparency and gather feedback.

API Platform

Vision

For API producers and consumers, internal and external to Wikimedia, who need to create, manage, discover, and use APIs, the API Platform is a set of tools, processes, and best practices that empowers APIs as a method for creating and sharing free knowledge.

Different from existing APIs, our product breaks down barriers to entry for consumption and contribution to Wikimedia APIs

Products & Services

Product/Service Status Capabilities Documentation
API Gateway (Envoy) Status:    Done HTTP routing


https://wikitech.wikimedia.org/wiki/API_Gateway
API Portal (Mediawiki) Status:    In Progress API discoverability https://api.wikimedia.org/wiki/Main_Page
API Guidelines Status:    In Progress Design & development guidance https://api.wikimedia.org/wiki/Community/API_guidelines
Service Catalog (Backstage) Status:    In Progress Service discoverability Prototype: https://backstage-api-catalog.toolforge.org/
Example Node API Status:    In Progress
Service Template Node Status:    Done
Service Scaffolding Status:    Not Started
API Development CI Tooling Status:    In Progress

Artifacts

Demo Sessions

Note: You'll need to be signed in with your WMF account to view these videos.

2021/09/02 API Process & OAuth Flows (Seve Kim, Bill Pirkle, Nikki Nikkhoui)

Notes

Informal notes taken to document learnings/points for future documentation as the Platform is developed