DEV Community

Cover image for Backstage Developer Portal: คู่มือฉบับสมบูรณ์และแนวทางปฏิบัติที่ดีที่สุด
Thanawat Wongchai
Thanawat Wongchai

Posted on • Originally published at apidog.com

Backstage Developer Portal: คู่มือฉบับสมบูรณ์และแนวทางปฏิบัติที่ดีที่สุด

พอร์ทัลสำหรับนักพัฒนา Backstage เป็นแพลตฟอร์มโอเพนซอร์สที่สร้างโดย Spotify สำหรับจัดการความซับซ้อนของการพัฒนาซอฟต์แวร์ระดับองค์กร ทำหน้าที่เป็นศูนย์กลางที่ทีมวิศวกรสามารถค้นหา จัดทำเอกสาร จัดการ และดำเนินการกับส่วนประกอบซอฟต์แวร์, API, บริการ และโครงสร้างพื้นฐานต่างๆ ผ่านอินเทอร์เฟซเดียว

ลองใช้ Apidog วันนี้

เมื่อองค์กรขยายตัวและทีมเติบโตขึ้น การค้นหาเอกสารและติดตามความเป็นเจ้าของมักกลายเป็นปัญหา Backstage แก้ไขโดยนำเสนอแพลตฟอร์มศูนย์กลางที่ปรับแต่งได้สำหรับการมองเห็น การค้นหา และบริการตนเอง ทำให้นักพัฒนาทำงานได้เร็วขึ้นและลดอุปสรรค

ทำไมพอร์ทัลสำหรับนักพัฒนา Backstage จึงสำคัญ

Backstage เป็นมากกว่า wiki หรือ dashboard ทั่วไป เป็นการลงทุนเพื่อประสิทธิภาพนักพัฒนา บริษัทอย่าง Spotify, Wise, Netflix เลือกใช้เพราะ:

  • การรวมศูนย์ความรู้: เอกสาร, ข้อมูล API, รายละเอียดความเป็นเจ้าของ, เครื่องมือโครงสร้างพื้นฐาน อยู่ในที่เดียว
  • ประสบการณ์นักพัฒนาที่ดีขึ้น: ค้นหาทรัพยากรและเริ่มต้นโครงการได้ง่ายขึ้น
  • ระบบอัตโนมัติแบบบริการตนเอง: นักพัฒนาสามารถสร้าง/ปรับใช้บริการหรือ API ได้เอง
  • ความสอดคล้องและ compliance: บังคับใช้มาตรฐานองค์กรด้วย template, scorecard, automate check
  • ปรับขนาดง่าย: รองรับ microservice และทีมขนาดใหญ่

Backstage ที่ใช้งานดีจะเป็น backbone ขององค์กรวิศวกรรมที่ขับเคลื่อนเร็ว

คุณสมบัติหลักของ Backstage

เจาะลึกฟีเจอร์หลักที่ควรรู้และนำไปใช้:

1. แค็ตตาล็อกซอฟต์แวร์

Software Catalog คือฐานข้อมูลรวมศูนย์สำหรับส่วนประกอบซอฟต์แวร์ทั้งหมด เช่น service, library, API, pipeline แต่ละรายการจะมี:

  • เจ้าของ (ทีม/บุคคล)
  • คำอธิบายและลิงก์เอกสาร
  • ลิงก์ repo
  • สถานะ deployment/environment
  • Resource ที่เกี่ยวข้องและ dependency

ช่วยให้รู้ว่าใครรับผิดชอบและค้นพบ component ที่ reuse ได้

2. การจัดการ API

Backstage ผสานกับ API spec (OpenAPI, Swagger, GraphQL ฯลฯ) และแสดง interactive API doc พร้อมโค้ดและข้อมูลเจ้าของ

ตัวอย่างการใช้งาน:

# ตัวอย่าง entity สำหรับ Backstage API Catalog
apiVersion: backstage.io/v1alpha1
kind: API
metadata:
  name: payment-service
  description: Payment API สำหรับระบบหลัก
spec:
  type: openapi
  lifecycle: production
  owner: team-payments
  definition:
    $text: ./openapi.yaml
Enter fullscreen mode Exit fullscreen mode

แนะนำ: ใช้ Apidog ออกแบบ/จัดทำเอกสาร API และเชื่อมโยงเข้า Backstage เพื่อวงจรชีวิต API ที่ครบถ้วน

3. เทมเพลตซอฟต์แวร์

Software Template ช่วยให้สร้างบริการใหม่หรือ infra component ตาม best practice ได้รวดเร็ว Template กำหนด:

  • Tech stack (Node.js, Go, Python ฯลฯ)
  • การตรวจสอบ security/compliance
  • มาตรฐานเอกสาร
  • CI/CD integration

ลด tech debt และทำให้ onboard เร็ว

4. ระบบนิเวศปลั๊กอิน

Backstage ขยายได้ด้วยปลั๊กอินจาก community หลายร้อยตัว เช่น:

  • Kubernetes cluster/deployment
  • CI/CD (Jenkins, GitHub Actions, GitLab CI)
  • Incident management (PagerDuty, Opsgenie)
  • API doc tool (เช่น Apidog)
  • Security/compliance dashboard

Backstage มี search ที่ powerful ค้นหาบริการ, API, repo, documentation, owner ได้ทันที

6. ศูนย์กลางเอกสาร

เอกสารแบบ docs-as-code (Markdown ฯลฯ) อยู่กับ service/data pipeline จริง ลดปัญหาเอกสารล้าสมัย

องค์กรใช้งาน Backstage อย่างไร

การ onboarding สำหรับ dev ใหม่

  • ดู catalog ของ service/API ที่มี
  • เข้าใจเจ้าของทีมและ dependency
  • เข้าถึงคู่มือ onboarding/runbook ทันสมัย
  • สร้างบริการใหม่ผ่าน template

ความเป็นเจ้าของบริการ

  • ระบุเจ้าของชัดเจน ป้องกันบริการ orphan
  • ส่งต่อ incident หรือ question ได้เร็ว
  • ติดตามสถานะ/incident ของ service

การออกแบบและจัดทำเอกสาร API

ใช้ Apidog ออกแบบ/Doc API แล้วเปิดเผยผ่าน Backstage ให้ค้นหา/ทดสอบ/ร่วมงานง่าย

โครงสร้างพื้นฐานแบบบริการตนเอง

วิศวกรสร้าง environment, จัดสรร cloud resource, deploy microservice ผ่าน self-service portal ไม่ต้องรอ ops

เมตริกและมาตรฐานทางวิศวกรรม

  • ติดตาม code quality/test coverage
  • ตรวจสอบ compliance
  • monitor ช่องโหว่และสถานะแก้ไข

แนวทางปฏิบัติที่ดีที่สุดในการตั้งค่า Backstage

1. เริ่มด้วยแค็ตตาล็อกที่ครบถ้วน

รวบรวมบริการ, API, library ทั้งหมดใน catalog ระบุเจ้าของ/ลิงก์เอกสารให้ชัดเจน

2. ผสานรวมเครื่องมือ API

เชื่อมการออกแบบ/Doc API (เช่น Apidog) เข้า Backstage, นำเข้า spec เพื่อให้แสดง doc ที่เดียว

3. บังคับใช้มาตรฐานด้วย template

สร้าง template สำหรับ project ใหม่ เพื่อความสม่ำเสมอด้าน security/compliance/doc

4. ปรับปรุง UX

ปรับ UI/UX ของ portal ให้ตรง workflow องค์กร เช่น branding, shortcut, plugin สำคัญ

5. ส่งเสริมวัฒนธรรม documentation

ให้ทีมดูแล docs-as-code เสมอ ใช้ฟีเจอร์ doc ของ Backstage ทำให้การอัปเดตเป็นส่วนหนึ่งของ dev workflow

6. อัตโนมัติทุกจุดที่ทำได้

อัตโนมัติ onboarding, สร้างบริการ และ routine operation ด้วย plugin/integration ลด manual work

ตัวอย่างจริง: Wise กับ Backstage

Wise ใช้ Backstage แก้ปัญหา document quality/ค้นหา/ภาระคิดโดย:

  • รวมศูนย์เอกสารบริการ/API ทำให้ค้นหาได้ทันที
  • ปรับปรุงการแมปทีม/เจ้าของ บริหาร incident ง่ายขึ้น
  • ผนวก API design/doc (เช่น Apidog) ใน workflow
  • template self-service ช่วยให้สร้างบริการใหม่ได้เร็วตาม best practice

ผลลัพธ์: onboarding เร็วขึ้น, dev พึงพอใจ, ความเร็ว engineering เพิ่ม

การผสาน Apidog กับ Backstage

เวิร์กโฟลว์แนะนำ:

  1. ออกแบบ/ทดสอบ API ใน Apidog: UI กราฟิก ออกแบบ endpoint, mock response, gen interactive doc
  2. Export spec เข้า Backstage: นำเข้า Swagger/OpenAPI spec จาก Apidog สู่ portal แสดงคู่กับ code/detail
  3. Enable API discovery & governance: dev ค้นหา/ทดลอง/ดู doc API ใน Backstage ได้เลย

ช่วยลดรอบ dev, ส่งเสริมการ adopt API และ doc สอดคล้องของจริง

FAQ: คำถามพบบ่อยเกี่ยวกับ Backstage

องค์กรประเภทใดเหมาะกับ Backstage?

เหมาะกับองค์กรที่มีบริการ/API/ทีม dev หลายทีม หรือมีปัญหา doc กระจัดกระจาย/self-service ติดขัด

Backstage เป็นโอเพนซอร์สหรือไม่?

ใช่ เป็น open source (Apache 2.0) และมี managed/commercial service (เช่น Spotify Portal, Roadie)

Backstage ปรับแต่งได้หรือไม่?

ขยาย/ปรับแต่งได้เต็มที่ ทั้ง plugin, theme, custom workflow

Backstage เกี่ยวข้องกับ API management อย่างไร?

เป็นศูนย์กลางค้นหา/doc/จัดการ API เชื่อม Apidog เพื่อ design/test/doc API ได้ครบวงจร

สรุป: เพิ่มขีดความสามารถทีมวิศวกรรมด้วย Backstage

Backstage เปลี่ยนวิธีทำงานขององค์กรวิศวกรรม: ศูนย์กลางความรู้, onboarding ง่าย, enforce standard, ส่งเสริม self-service ลดอุปสรรคและเร่ง delivery

ไม่ว่าจะเพิ่งเริ่มหรือมีบริการนับร้อย การลงทุนใน Backstage และผสาน Apidog สำหรับ API dev จะช่วยเพิ่มความสุข dev ลดค่าใช้จ่าย operation และขับเคลื่อนธุรกิจเร็วขึ้น

Top comments (0)