API Product Managers, what's your workflow when designing and maintaining an API?

1

API Blueprint

As for the actual process of building the contract, what works well for me is using API Blueprint-style Markdown in a compatible tool like Apiary, which renders your content into Swagger-like documentation as you type. This way, I and others can mutually "live-scribe" the API contract as we discuss, and seeing it on-screen helps to get people on the same page (and sometimes highlight potential issues that would have gotten lost in a series of notes).

#API Design #API Tools #API Prototyping 9 social mentions

2

Apiary

As for the actual process of building the contract, what works well for me is using API Blueprint-style Markdown in a compatible tool like Apiary, which renders your content into Swagger-like documentation as you type. This way, I and others can mutually "live-scribe" the API contract as we discuss, and seeing it on-screen helps to get people on the same page (and sometimes highlight potential issues that would have gotten lost in a series of notes).

#API Tools #APIs #API Management 7 social mentions

3

Google Site Reliability Engineering

Define SLOs for availability and latency. Google's SRE book is good reading for this.

#Developer Tools #DevOps Tools #Education & Reference 84 social mentions