DevCoach 183: Back-End | Dokumentasi API

Pahami cara menyusun API Documentation, mengapa dokumentasi ini krusial untuk keberhasilan pengembangan, dan temukan tools terbaik untuk menciptakannya.

Transcript

1. Dokumentasi API Arsy Opraza Akma Curriculum Developer Back-End
2. Hi, I’m Arsy Opraza Akma 👋 Latest Work Experiences: • Curriculum Developer, Dicoding 2023 - present • Back-End Engineer, Rey.id 2022 • Software Engineer, Kompas Gramedia 2021-2022 Education: • Universitas Komputer Indonesia 2019 - 2023 Bachelor of Computer Science About Me Arsy Opraza Akma arsyopraza.com
3. Agenda 1. Mengetahui pentingnya API Documentation 2. Menerapkan API Documentation dengan OpenAPI 3. Demo implementasi API Documentation Back-End
7. Why API Documentation? • DevEx Developer Experience) • Mempermudah pemeliharaan • Menghemat cost dan waktu • Pengujian • Standar Industri Back-End
8. What is API Documentation? API documentation adalah kumpulan instruksi yang dapat dibaca manusia tentang cara menggunakan dan menghubungkan aplikasi ke API. Back-End
9. Gimana sih cara nerapin API Documentation? 🤔 Back-End
10. OpenAPI Specifications OpenAPI Specifications OAS) adalah standar dalam mendefinisikan sintaks dan struktur API yang berbasis HTTP (biasanya RESTful API. Back-End
11. Sejarah OAS OpenAPI berawal dari suatu standar bernama Swagger UI. Swagger UI berkembang → Menjadi standar banyak orang. Back-End
12. Sejarah OAS Di tahun 2015 Swagger diakuisisi oleh perusahaan SmartBear. Pada masa akuisisi ini, namanya berubah menjadi “OpenAPI Specificationsˮ Back-End
13. OpenAPI Specifications OpenAPI Specifications, terdapat informasi detail dari API seperti: • endpoints yang tersedia dan method-nya. • parameters dari endpoint Query Parameters atau Path Parameters); • metode autentikasi Oauth, API Key, dan Bearer Token); • deskripsi API; dan • informasi kontak atau lisensi API, beserta terms yang digunakan. Back-End
14. Quiz #1 DevCoach 183 Sebutkan salah satu informasi yang terdapat pada OpenAPI Specifications! Back-End
15. OpenAPI Document API dideskripsikan di dalam satu dokumen yang disebut dengan OpenAPI Document. Di dalamnya harus berisi setidaknya satu dari: • path, • components, • webhooks. OpenAPI Document ini memiliki format JSON atau YAML. Back-End
17. Open-source tools Swagger adalah tools yang memungkinkan untuk mendeskripsikan RESTful API dengan OpenAPI Specifications. Back-End
18. Swagger tools Swagger memiliki beberapa tools seperti: • Swagger Editor • Swagger UI • Swagger Codegen • Swagger Core • Swagger Parser • Swagger APIDom Back-End
22. Quiz #2 DevCoach 183 Apa spesifikasi yang digunakan untuk membuat API Documentation? Back-End
23. Back-End Demo Implementation API Documentation
24. Quiz #3 DevCoach 183 Apa nama dependencies tools OpenAPI yang ada di Hapi? Back-End
25. Thank You arasopraza aras@dicoding.com arasopraza Back-End arsyopraza
26. Feedback! dicoding.id/devcoachfeedback