Author Archive

How we build our API documentation

API DocumentationIf you have ever used APIs you know that good documentation is important. It should also always be up-to-date. In this post I’m not going to discuss how to write documentation and what is required, but rather which tools we use to get the documentation updated as quickly as possible on our developer portal (developer.leaseweb.com).

We employ a number of different tools to help with the process.

  1. RAML (raml.org)

Good documentation starts with good specifications. For this we have decided to use RESTful API Modeling Language (RAML) (created by MuleSoft), together with tools like raml2html (https://github.com/raml2html/raml2html) for creating HTML. Using templates, we can create the HTML as we need it for further processing. Within the RAML specifications, we give descriptions to each endpoints that will become the documentation a user can see on the site.

We already had experience with RAML, which made our choice easy, but there are other tools/specifications around that can do the same. Swagger (swagger.io) is probably the largest and most supported framework around.

Read the rest of this entry »

LeaseWeb on Twitter

"Data beyond boarders - Reliable Cloud Hosting in a changing world" at Cloud Expo Europe. Leaseweb experts will be at booth C1650 to help with your hosting needs lsw.to/l7t

test Twitter Media - "Data beyond boarders - Reliable Cloud Hosting in a changing world" at Cloud Expo Europe. Leaseweb experts will be at booth C1650 to help with your hosting needs https://t.co/S8jPiyODAJ https://t.co/ElQlV81Kfp

Don't miss Hagen Rother explain how it’s possible even for small start ups to run on bare metal and how to stay away from vendor lock in! Sign up today! lsw.to/l73 #Berlin #Meetup #Infrastructure #Growth

test Twitter Media - Don't miss Hagen Rother explain how it’s possible even for small start ups to run on bare metal and how to stay away from vendor lock in! Sign up today! https://t.co/b4bfQVnShb #Berlin #Meetup  #Infrastructure #Growth https://t.co/H1k6iVqyTR

Berlin E-Commerce Expo is filled with more than 3000 attendees from B2B to B2C industries! Get your FREE ticket and meet us at booth C12. Sign up to take part: lsw.to/l7V #ecommexpo #Berlin #Networking

test Twitter Media - Berlin E-Commerce Expo is filled with more than 3000 attendees from B2B to B2C industries! Get your FREE ticket and meet us at booth C12. Sign up to take part: https://t.co/0UrdIIATlo #ecommexpo #Berlin #Networking https://t.co/iVM09FUddL

Special offer for visitors when you book an appointment! - Available only during #EXPO! Book now! lsw.to/l7V #Berlin #E-Commerce

test Twitter Media - Special offer for visitors when you book an appointment! - Available only during #EXPO! Book now! https://t.co/0UrdIIATlo #Berlin #E-Commerce https://t.co/PJcbUYwEoe