Application Programming Interface (API) Spec

Application Programming Interface (API)

Application Programming Interface (API) – In any tech company level whether you are a startup or an enterprise company, task and time management is a vital point to do it right. One of many things that help us to optimize task and time management in software development phase is what we called API (Application Programming Interface) Specs. For example, you wanted to build a login feature inside your product, let’s have a quick recap what is the timeline when you develop login feature without API specs defined first. Let’s say we have a project with an estimated time of 1 month to complete.

In that project, we have a backend team, frontend team, and QA team.

After all agree on the API spec that has been made.

in the end, we can deliver the project to the client on time as expected.

So, without API (Application Programming Interface) spec frontend team needs to wait backend service to be ready then they can start integrating the API.


Total time needed will be longer, if some bugs are raised like some data on response missing frontend team needs to wait again until backend service is fixed. In the end, the project will be completed beyond the estimated time that has been determined.

Tools Application Programming Interface

Pre-requisite to creating API (Application Programming Interface) specs is:

Based on UI design, backend developer, frontend developer and QA need to discuss 5 things:

does this API (Application Programming Interface) request requires authentication or not?

and what authentication being used? is it basic authentication ,token based authentication, et cetera?

is this API (Application Programming Interface) only limited to specific user levels?

What Method used and specific URL to call?

Either as body payload or URL parameters, we need to define what data being sent to backend?

On our example for login API (Application Programming Interface), we have multiple case where login is success or login is failed, or account is banned etc. so for each case will have different HTTP code and response data format and we need to clearly write it inside the API Specs.


Api (Application Programming Interface) Specs need to meet Open API standardization with API specs, every team can work in parallel without waiting for other teams to complete their part first and based on timeline shows, it could save time and optimize task and time management on development phase.

To get more popular information about startup, check others article in Blankontech.

Related posts

How To Implement Gitflow Inside Our Development Project

by Hendrik Tukunang
1 year ago

UX Analytics

by Antonio Tangkudung
1 year ago

Blocked vs Non Blocked Technology

by Antonio Tangkudung
1 year ago
Exit mobile version