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 3Scale and recently Apiphany. 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.

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.

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. 

This site will be an open source informational and technical repository of the 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.