Plumber — Building an API


Training

Plumber — Building an API

1. Introduction

Exegetic Analytics is a Data Science consultancy specialising in data acquisition and augmentation, data preparation, predictive analytics and machine learning. Our services are used by a range of industries from Education to Security, Food Delivery to Politics. Our consultants are based in Durban and Cape Town and we engage with clients all over the world. Our products and services are used by a multitude of industries including Aerospace, Education, Finance, Food and Transport.

Exegetic Analytics also offers training, with experienced and knowledgeable facilitators. Our courses focus on practical applications, working through examples and exercises based on real-world datasets.

All of our training packages include access to:

  • our online development environment and
  • detailed course material which participants will have continued access to even once the training has concluded.

For more information about what we do, you can refer to our website.

These are some of the companies who have benefitted from our trainning:

Take a look at our full list of courses to see what other training we have on offer.

Contact Us

If this proposal is of interest to you or you would like to hear more about what we do you can get in touch on training@exegetic.biz or +27 (0)73 805 7439.

2. Course Description

Plumber is a package which makes it possible to expose R functions as API endpoints. This makes building an API simple and fun.

Details

Duration 1 day
Who should attend? Anybody who needs to put their R code or model into production.
Objectives In this course you’ll learn how to build an API which allows access to R functions and objects.
Outcomes After the course participants will be able to

  • create an API from a collection of functions;
  • create informative documentation;
  • handle various types of input and output;
  • apply simple authentication; and
  • deploy the API in the cloud.
Requirements Participants should be familiar with R and comfortable writing their own functions.

Return to our list of courses.

Course Outline

3. Course Outline

  • What is an API?
  • Making a Quick API
    • Function decoration
    • Input and output
    • Swagger
  • Input
    • Types of endpoints (mostly GET and POST but also PUT, DELETE and HEAD)
    • Filters
    • Dynamic routing
    • Parameters
    • The request object
    • JSON input
  • Output
    • The response object
    • Types of output (mostly JSON but also HTML, JPG, PNG and PDF)
    • Serving static files
    • Dealing with Errors
  • Documentation
  • Security
    • Cookies
    • Authentication with {sealr}
  • Deploying an API
    • DigitalOcean and AWS
    • Docker
    • NGINX

Book now!

Training Philosophy

Our training emphasises practical skills. So, although you'll be learning concepts and theory, you'll see how everything is applied in the real world. We will work through examples and exercises based on real datasets.

Requirements

All you'll need is a computer with a browser and a decent internet connection. We'll be using an online development environment. This means that you can focus on learning and not on solving technical problems.

Of course, we are happy to help you get your local environment set up too! You can start by following these instructions.

Package

The training package includes access to
  • our online development environment and
  • detailed course material (slides and scripts).

Return to our list of courses.