API S

TYLE

GUID

ES

A P

RI M

ER Kris Chant

@sprshrpSr. Product Manager - APISalesforce Marketing Cloud

WHAT MAKES APIS SUCK?

?

WHAT MAKES APIS SUCK?

Developers• Predictabl

e• Performa

nt• Painless

Organization• Enable

Rapid Development

• Reduce Support Cases

WELL DESIGNED REST APIS:

WHAT IS A STYLE GUIDE?

• Defines Design Traits of your API• Common attributes• Interaction patterns

DO:• Consistent

Names• Predictable

Patterns• Meaningful

Errors• Be opinionated

DON’T:• Impede

Developers• Ignore

Developers and Users

• Favor Dogma over Pragmatism

DESIGN YOUR STYLEGUIDE

Developers• Predictabl

e• Performa

nt• Painless

Organization• Enable

Rapid Development

• Reduce Support Cases

WHY HAVE A STYLE GUIDE?

WHEN TO IMPLEMENT?

Now!

OTHER TOPICS

• API Design as a Discipline• Talking to your

Developers• Enforcement of Style

Guide

THANK YO

U!

Feedback? Twitter:

@sprshrp