No content

Ryuta Hamasaki @avosalmon

Agenda • Design-First API Development • Overview of OpenAPI • Designing API contract • Running mock server • Validating API response in testing

Design-First API Development • Design API contract first • Find and solve problems early on before building API • FE implements the feature using the mock API 👉 No need to wait until API is built • BE implements the API based on the API contract 👉 Validate API response in testing

Overview of OpenAPI • Documentation for REST API written in YAML or JSON • Previously known as Swagger • Swagger specification was donated to the OpenAPI Initiative • Swagger = tools to implement OpenAPI specification

Designing API Contract

No content

No content

No content

Rendering OpenAPI

Rendering OpenAPI • Stoplight (paid service) • Swagger UI • Swagger Hub (paid service) • Swagger Viewer (Chrome extension)

No content

No content

No content

No content

Running mock server • Prism - OSS mock server for OpenAPI • Built by Stoplight • Returns response based on the OpenAPI schema • FE can use the mock server while BE is building the API • Docker image is available

Validate API response in feature tests • Make sure the actual response shape follows 
 the API contract • Spectator -> Didn’t work for me • Custom response assertion • league/openapi-psr7-validator • nyholm/psr7 • symfony/psr-http-message-bridge

Key take-aways • Design API contract before writing code • FE & BE develop the feature in parallel • OpenAPI is not just a documentation • Mock Server • Validate API Response in testing • Choose the right tool that works for you