Kalau kamu lagi bikin API

@septiawanajipradana

16.7K followers · usually 8.5K views a post

Views

43.3K

Likes

3.0K

Comments

11

Shares

130

SoundTikTok sound · original sound - septiawanajipradana

Promoted product

Scalar

Scalar is an open-source API platform: 🌐 Modern REST API Client 📖 Beautiful API References ...

Why it worked

The video provides a practical solution to a common developer problem (API documentation) using a free and open-source tool. It clearly demonstrates the benefits and ease of use, making it highly relevant and valuable for its target audience.

Summary

The video demonstrates how to create API documentation using Scalar, a free and open-source tool. It explains that good API documentation is crucial for developers and clients, and Scalar helps generate this documentation from source code, allowing for easy testing and parameter modification.

Structure

1Introduction to API documentation needs
2Introducing Scalar as a solution
3Explaining Scalar's features and benefits
4Demonstrating Scalar's integration with Node.js/Express.js

Original caption

Bikin API jangan cuma asal jalan. Kalau API itu dipakai frontend developer, mobile developer, QA, atau client, mereka butuh dokumentasi yang jelas. Endpoint-nya apa, method-nya apa, request body-nya gimana, response-nya seperti apa. Nah, salah satu tools yang bisa dipakai adalah Scalar. Scalar ini alternatif Swagger UI yang tampilannya lebih modern dan clean. Cocok buat dokumentasi API dari file OpenAPI. Jadi API kamu nggak cuma jalan, tapi juga enak dipakai tim lain. #programmer #developer #softwarehouse

More from @septiawanajipradana

Product placement

The video shows code for an API built with Node.js and Express.js, then transitions to a web interface displaying API documentation generated by Scalar, including endpoints, request/response examples, and a testing interface. The GitHub repository for Scalar is also shown.

On-screen text

Kalau kamu lagi bikin API Kalau kamu lagi bikin API Jangan cuma fokus bikin codingannya doang Kamu juga wajib bikin dokumentasinya Karena yang pakai api nya itu bisa jadi bukan cuma kita Ada front-end developer, mobile developer, tim QA Bahkan klien yang butuh akses ke API kita Nah, daripada semuanya dijelasin manual lewat chat atau file catatan kita bisa bikin API documentation yang lebih rapi Salah satu tools yang bisa dipakai adalah Scalar Scalar ini tools gratis dan open source untuk bikin dokumentasi API dari file OpenAPI Ini contohnya gue pakai Node.js dan Express.js untuk membuat suatu API Ya codingannya kayak biasa aja cuma nanti kita masukin Scalar ke project ini Scalar bakal nge-generate API documentation dari source code kita Contohnya kayak gini kita bisa langsung test request di websitenya Kita bisa melakukan simulasi untuk request-nya dan juga bisa merubah setiap parameternya Dengan adanya API documentation kayak gini orang yang mau konsum API kita akan lebih mengerti Gimana cara pakai dan akses API yang kita buat Semoga bermanfaat

Transcript

Kalau kamu lagi bikin API Kalau kamu lagi bikin API Jangan cuma fokus bikin codingannya doang Kamu juga wajib bikin dokumentasinya Karena yang pakai api nya itu bisa jadi bukan cuma kita Ada front-end developer, mobile developer, tim QA Bahkan klien yang butuh akses ke API kita Nah, daripada semuanya dijelasin manual lewat chat atau file catatan kita bisa bikin API documentation yang lebih rapi Salah satu tools yang bisa dipakai adalah Scalar Scalar ini tools gratis dan open source untuk bikin dokumentasi API dari file OpenAPI Ini contohnya gue pakai Node.js dan Express.js untuk membuat suatu API Ya codingannya kayak biasa aja cuma nanti kita masukin Scalar ke project ini Scalar bakal nge-generate API documentation dari source code kita Contohnya kayak gini kita bisa langsung test request di websitenya Kita bisa melakukan simulasi untuk request-nya dan juga bisa merubah setiap parameternya Dengan adanya API documentation kayak gini orang yang mau konsum API kita akan lebih mengerti Gimana cara pakai dan akses API yang kita buat Semoga bermanfaat