Technology · Ebook

Stoplight: Design-First API Development

by Shriira Press

A practical, in-depth guide to Stoplight, the platform and toolset for design-first API development built on OpenAPI. Learn how to build better APIs: the API design problem (code-first pitfalls, inconsistency, doc drift), OpenAPI and the design-first approach, Stoplight Studio (visual design), Spectral (linting and governance), Prism (mock servers and contract testing), Elements (documentation), API governance and style guides at scale, and fitting design-first into Git and CI/CD workflows.

Contents

1. 1Preface
2. 2Chapter 1 — What Stoplight Is
3. 3Chapter 2 — The API Design Problem
4. 4Chapter 3 — OpenAPI and the Design-First Approach
5. 5Chapter 4 — Stoplight Studio — Visual API Design
6. 6Chapter 5 — Spectral — API Linting and Governance
7. 7Chapter 6 — Prism — Mock Servers and Contract Testing
8. 8Chapter 7 — Elements — API Documentation
9. 9Chapter 8 — API Governance and Style Guides at Scale
10. 10Chapter 9 — Operations and Workflow
11. 11Chapter 10 — Stoplight in Practice