You are viewing an old conference website from year 2017. (main conference website)

MockQ buddy! Easy API Driven Design and Accurate Documentation with GraphQL

Time: 16:22 - 16:30      Duration: 00:08      Format: Lightning

In this talk I will demonstrate how to rapidly get a GraphQL service running with realistic mock data that consumers can develop against and discuss. In parallel we use the same schema to provide the real data and accurate, up-to-date documentation.

GraphQL fills in so many gaps which Rest leaves you to deal with. At Cardano, GraphQL is integral to our technology reboot. I will cover what I would have really liked when I started with GraphQL, for myself and to sell to management.

Like with interface driven design for coding, API Driven design allows consumers and producers to agree upon the common API interface then have each team independently start working on either side of this API. Using Node.js, Express, Apollo and GraphQL we’ll start with a schema, quickly get a service running with simple mock data then iterate with more accurate and complex mocks. Next, we leave this running for the UI developers to use whilst we start on the real service in parallel. No need for an external service, just start in the code.

Once released consumers need accurate API documentation and to try it out. Traditional methods like Wiki’s, annotation or codegen such as Swagger still require the developer to update them and of course we all know how often this happens, not! GraphQL’s schema means your documentation comes from the same code used to create the real service. Plus, you get the nice GraphiQL portal built in to your service to view this documentation and try the service.

Slides

Speaker

Alison Johnston

Alison Johnston

Cardano

Living in London, at the heart of the silicon roundabout allows me to feed my addiction for software development. It is my creative outlet and is what gets me out of bed in the morning (most of the time) and into the lush green fields at my new role with Cardano. It’s one of those chance of a lifetime jobs to take an established company with a whole new business, so more like a startup, and lead the leap onto the web using my experience in many areas from physics, to my own tech startup, consulting, to software for the arts, training and investment banking.

Please wave hello if you see me in the London Lord Mayors parade as a Freeman of the Worshipful Company of Information Technologists or escaping it all scuba diving around the globe.