Fork me on GitHub

API Design

In the early days APIs were just about deploying and consuming. You were doing one or the other. Then came API management from providers like Mashery, then others like 3Scale and Apigee. Now the API universe is expanding and API design is coming front and center with new approaches, tools and even companies stepping up to provider services.

I define the world of API design as everything that goes into planning and designing your API, as well as the design of your API that lives on as your operational interface, and the truth in the contract you are entering into with API consumers.

Depending on our needs, API design may begin with learning about HATEOAS as part of your design definition or API design might be just about generating a Swagger definition so you can generate interactive API documentation, or possible automate your API monitoring and testing.

Ultimately your API design will be the definition of each endpoint, its methods, fields and much more. In a technical sense it is a JSON or XML blueprint that describes your API, and in a creative sense, API design is an art and can possess a strange technical beauty and speak to the value it delivers to end-users.

Thoughtful API design early on can save you a lot of mistakes down the road. This site is not meant to endorse any particular approach or methodology, but provide a single resource where you can find the best information on API design, allowing you to have a conversation around an API definition throughout its lifecycle.

This site will be an open source informational and technical repository of the companies, building blocks of API design, tools for assisting you in your API design planning and execution and companies that provide services in the area of API design.

My goal is to provide the information you need to navigate the world of API design. I’m also working on a white paper which will be published here when ready.


Introducing the Anypoint Platform for APIs

(Posted on )

I am very excited to announce the general availability of the Anypoint Platform for APIs July 2014 release.This release places a broad set of rich API tooling at developers fingertips, allowing them to address the entirety of the API lifecycle in a more efficient and effective manner.The release also enables API program owners to deliver a robust API platform that can easily integrate with existing enterprise assets.The significant set of enhancements introduced in this release revolves around three core themes.360 degree API life-cycle This new release unifies the user experience across the API lifecycle to streamline the creation, management and......read more.



Best Practices REST API from Scratch - Introduction

(Posted on )

The current internet ecosystem has literally been invaded by APIs, and for good reasons.By using third party APIs in your products or services, you have access to a ton of useful features — such as authentication or storage services — that can benefit both you and your users.By exposing your own API, your application becomes “part of the mix” and will be used in ways you’ve never thought before… if you do it the right way, obviously.In this two part series I’ll show you how to create a RESTful API layer for your PHP applications, using a collection of real......read more.