2016 - DevOps Meets APIs - Model once. Benefit everywhere

Preview:

Citation preview

DevOps meets APIs. Model once, benefit everywhere.

Marc MacLeod CEO, StopLight.io

“aims at establishing a culture and environment where

building, testing, and releasing software, can happen rapidly, frequently, and more reliably”

- Wikipedia + 3?

!Me

!Buddy

! !!Departments

!

Services

Background Processes

Orchestration Layers

Value Production

Efficiency Loss

DEVOPS

“aims at establishing a culture and environment where

building, testing, and releasing software, can happen rapidly, frequently, and more reliably”

- Wikipedia + 3?

“aims at establishing a culture and environment that maximizes

predictable efficiency”

Services -> Microservices -> Serverless

Coding SDKs

Monitoring

Testing

Documentation

Compliance

API Process

Coding SDKs

Monitoring

Testing

Documentation

Compliance

API Process, Microservices

Service A

Coding SDKs

Monitoring

Testing

Documentation

Compliance

Service B

Coding SDKs

Monitoring

Testing

Documentation

Compliance

Service D

Coding SDKs

Monitoring

Testing

Documentation

Compliance

Service D

Problem #1

Communication

Docs - Technical WritersTesting - QA

Implementation - Engineering

Problem #2

Duplication

Docs - Technical WritersTesting - QA

Problem #3

Thoroughness

This sucks.

So tests often end up looking like this…

Problem #1Communication

Problem #2Duplication

Problem #3Thoroughness

Significant In-efficiencies

API Specifications

OpenAPI Specification (Swagger)

RAML

Blueprint

Response structures + examples

Request structures + examples + descriptions

Example OAS / Swagger

Fuzz Testing

Mock Server

SDK Generation

Compliance

Monitoring

Testing

Documentation

Single Source of Truth

Problem #1Communication

Problem #2Duplication

Problem #3Thoroughness

Single point of reference for all stakeholders.

Single source for artifact generation.

Single place to update.

Contract Testing

Succinct assertions that leverage our “contract”.

Describe the request.

Our “contract” from earlier.

Tests!

Bi-Directional

One portable file, that programmatically and thoroughly describes your entire API

contract, and includes the simple test flows to prove that contract is still valid.

Contract Testing

Spec File (contract)

Documentation

Testing SDKs

Mocking

Monitoring (contract testing)

Compliance

Model Once. Benefit Everywhere.

" Reduce departmental friction.

" Reduce duplication.

" Reduce inconsistencies / errors.

= Increase organizational efficiency.

Recommended