Main > stdout.in Ievgen Kuzminov IT blog

Posts by tag : api

Good REST API design - read, learn, create!

restful api

REST API design is still a topic under discussion. I'll try to collect list of resources for web developers who want get deeper into it.

Free e-books

Start with Apigee: Web API Design.

Continue with more advanced topics in Thoughts on RESTful API Design .

Addtional interesting apects are covered in HTTP API Design Guide

To get brief understanding on different aspects of API variations refer to Undisturbed REST. Also it covers some instruments for building and prototyping APIs.

Non free books

If you want even more additional info and "other points of view"

Play

  • Apiary - powerful service to design, prototype, document and test APIs.
  • MuleSoft. Anypoint Platform - Complete platform with API Design Studio for API protyping and documentation.

Specifications / Auto docs

RESTful API concepts are clear, but big and complex app still require more predictable way to organize APIs. People try to find a way to provide standartized way for documenting and organizing REST API protocol.

  • Swagger - is a simple yet powerful representation of your RESTful API. Provides tools and standard to create GUI for API docs exploration and testing.
  • RAML - RESTful API Modeling Language (RAML) makes it easy to manage the whole API lifecycle from design to sharing.
  • JSONAPI - a specification for building apis in JSON. With the aim to make API response data normalized and API self explanatory.

Framework specific


Notes by tag : api


Apipie- Rails DSL and API documentation lib. Allows to specify validation, versioning etc.


Ievgen
Kuzminov "iJackUA"
Web Team Lead
at MobiDev (Kharkiv, Ukraine)
Code in Ruby and Elixir, but still love PHP. Explore ES6 and Vue.js. Explore databases, use Ubuntu and MacOS, think about IT people and management

Notes


Did you know ? Vagrant (1.5+) "Error: Remote connection disconnect. Retrying..." while loading is not a bug. It just try to detect when VM is loaded. Yep... very confusing.



Slick - really looks like "the last JS carousel you'll ever need". Responsive, touch-enabled, mouse-dragging, dynamic add/remove.



Tried yii2-pjax widget on blog. A few moment of work and you can navigate through Notes without page reload. Really cool!