MGMLaboratory
Back

Menu

01Home
02About Us
03Projects
04Publications
05Member
06Articles
07Contact

Let's Talk

Open in Mail app

Socials

Malang (ID) --:--Privacy PolicyTerms of Service

November 5, 20172 min read

Why Define a Transit API Before Building the AppWhy Define a Transit API Before Building the App

A design proposal from Malang shows how much of a transport app is settled by its data contract.

  • Journal
  • Publications

Written by

  • SRShirasaka RenIT & Infrastructure · Student Member

In this article

  1. 01Begin with the rider's questions
  2. 02Quality belongs in the schema
  3. 03What the proposal leaves open

Riders see an app. Developers see the contract underneath it, and that contract quietly decides which features are even possible. A 2017 proposal for local public transport in Malang is interesting less for its interface and more for the questions it forces a city to answer before code is written.

01/03

Begin with the rider's questions

The proposed interface reads like a list of things a passenger would ask at a terminal. Map each question to a shape of data and the design work is mostly done.

  • Which vehicle serves this trip, and what will it cost and take? These are read operations with parameters.
  • Can I call or book one? This is a write operation, which brings its own problems around identity and confirmation.
  • What modes exist, and what is each one actually like? These need list and detail resources.
A street in the Celaket area of Malang. Image: Evan Pasha, CC BY-SA 4.0, via Wikimedia Commons.
Fig. 01A street in the Celaket area of Malang. Image: Evan Pasha, CC BY-SA 4.0, via Wikimedia Commons.

02/03

Quality belongs in the schema

The proposal attaches six indices to every mode: comfortability, security, safety, privacy, availability, and accessibility. Putting those in the payload rather than in prose is a design decision with consequences. Values on a shared scale can be sorted, filtered, and compared across modes, while the same information buried in a description cannot.

It also raises the harder question of where those numbers come from. An index is only as good as the operator willing to maintain it.

A motorcyclist crossing the Suhat bridge in Malang. Image: Evan Pasha, CC BY-SA 4.0.
Fig. 02A motorcyclist crossing the Suhat bridge in Malang. Image: Evan Pasha, CC BY-SA 4.0.

03/03

What the proposal leaves open

The authors describe a draft, and the paper reports no deployed service and no measured result. Questions about authentication, rate limits, and how vehicle positions stay current are not settled here. The transport data itself still has to come from the operator.

Even so, the approach is worth copying. Write the contract first, and every rider app built afterward becomes a client rather than a rewrite.

Source

  1. Agi Putra Kharisma and Aryo Pinandito (2017). Design of REST API for Local Public Transportation Information Services in Malang City. Journal of Information Technology and Computer Science.

    DOI10.25126/jitecs.20172226 (opens in a new tab)

Next articleSketching a REST API for Malang Public Transport(Keep scrolling)(Read it next)(Loading)