API First

7 items tagged with "api-first"

Filter by type:

Best Practices1

API-First Design

An approach that treats the API contract as a product designed before implementation, so teams agree on the interface, then build clients and servers in parallel.

Blueprints3

Blueprint

REST API to GraphQL Federation Blueprint

Migrate a sprawling set of REST endpoints to a federated GraphQL graph so clients fetch exactly what they need from one typed endpoint.

Blueprint

REST to gRPC for Internal Services Blueprint

Replace JSON-over-HTTP calls between internal microservices with gRPC and Protocol Buffers for lower latency and strongly typed contracts.

Blueprint

Ad-Hoc REST Versioning to API-First Contracts Blueprint

Move from unmanaged REST API changes to an API-first workflow with OpenAPI contracts, contract testing, and a backward-compatibility policy.

Playbooks1

Playbook

API-First Transformation Program Playbook

An organization-wide program to adopt API-first design with contract governance, an API gateway, and a developer portal.

Checklists2

Checklist

API-First Design Review Checklist

Review an API design before implementation to ensure contract, versioning, and consistency standards are met up front.

Checklist

API Design Review Checklist

Review items for evaluating a new or changed HTTP API against design, consistency, and developer-experience standards.