---
title: การนำเข้า OpenAPI / Swagger
slug: th/user-guides/openapi-swagger
description: เรียนรู้วิธีใช้ประโยชน์จากการนำเข้า OpenAPI ใน Archbee สำหรับเอกสารผลิตภัณฑ์ที่เน้นนักพัฒนา ค้นพบประโยชน์ เวอร์ชันที่รองรับ วิธีการยืนยันตัวตน การเติมค่าพารามิเตอร์เริ่มต้นล่วงหน้า และการแสดงค่า ตัวอย่าง นี่คือความครอบคลุม
createdAt: 2021-10-29T07:42:12.000Z
---

## ทำไมต้องใช้การนำเข้า OpenAPI?

หากผลิตภัณฑ์ของคุณถูกสร้างมาสำหรับนักพัฒนา หรือผลิตภัณฑ์ของคุณมี API คุณจำเป็นต้องมีเอกสารประกอบผลิตภัณฑ์ที่ยอดเยี่ยม — ไม่เช่นนั้นคุณจะไม่สามารถเข้าถึงนักพัฒนาได้

เมื่อคุณนำเข้าไฟล์ OpenAPI ของคุณ Archbee จะอ่านและแปลงเป็น UI ที่สวยงามและทำให้พร้อมสำหรับการ:

- **แชร์สาธารณะ **(บนโดเมนแบบกำหนดเอง) 
- **ภายในองค์กร** กับเพื่อนร่วมงานและทีมของคุณ

เมื่อนำเข้าแล้ว คุณสามารถซิงค์ อัปเดต และทดสอบ OpenAPI ของคุณได้ ดูรายละเอียดเพิ่มเติมในส่วนด้านล่าง

## กฎและการตั้งค่าเริ่มต้น

:::hint{type="info"}
ไฟล์ OpenAPI ที่นำเข้าไม่สามารถแก้ไขได้ด้วยตนเองใน Archbee

หากต้องการอัปเดตและดูแล OpenAPI ของคุณ โปรดตรวจสอบ [ตัวเลือกการซิงค์](docId\:FnyQGQHFHvLOH6Jd5KCgF)
:::

### รองรับเวอร์ชัน OpenAPI:

Archbee รองรับเวอร์ชัน OpenAPI ต่อไปนี้สำหรับการนำเข้า:

1. เวอร์ชัน 2.0 และ 2.0.XX
2. เวอร์ชัน 3.0 และ 3.0.XX
3. เวอร์ชัน 3.1 และ 3.1.XX

### รองรับวิธีการยืนยันตัวตน

Archbee รองรับวิธีการยืนยันตัวตนดังต่อไปนี้:

1. [การยืนยันตัวตนแบบพื้นฐาน (Basic Authentication)](https://swagger.io/docs/specification/authentication/basic-authentication/)
2. [คีย์ API (API Keys)](https://swagger.io/docs/specification/authentication/api-keys/)
3. [การยืนยันตัวตนแบบ Bearer (Bearer Authentication)](https://swagger.io/docs/specification/authentication/bearer-authentication/)

หากคุณนำเข้าไฟล์ OpenAPI ที่มีวิธีการยืนยันตัวตนอื่น ๆ ระบบจะนำเข้าได้ถูกต้อง แต่จะไม่รองรับวิธีการยืนยันตัวตนนั้น

ซึ่งหมายความว่าคุณจะได้รับประสบการณ์การใช้งาน Archbee OpenAPI แบบเต็มรูปแบบ **ยกเว้น **ฟีเจอร์ Try It! หากเอ็นด์พอยต์ของคุณต้องการการยืนยันตัวตนที่ไม่ได้อยู่ในรายการด้านบน

### อื่น ๆ

1. หากคุณกำหนดพารามิเตอร์ "**default**" ใน OpenAPI ของคุณและระบุค่าให้มัน ตัวอย่างโค้ดและช่องพารามิเตอร์จะถูกเติมค่าล่วงหน้าให้อัตโนมัติ

   สิ่งนี้ทำให้ผู้ใช้หรือลูกค้าของคุณสามารถทดสอบ API ได้ง่ายขึ้นด้วย [ลองใช้!](docId:3joOjG_Ji7r1WGzrKMkBI) โดยไม่ต้องอัปเดตพารามิเตอร์ที่จำเป็นทั้งหมด

2. ถ้าคุณกำหนดพารามิเตอร์ "**example**" ใน OpenAPI ของคุณ ค่า example จะถูกแสดงทางด้านซ้ายถัดจากพารามิเตอร์ของ API

   สิ่งนี้ช่วยให้ผู้ใช้ของคุณเข้าใจได้ง่ายว่าพารามิเตอร์นั้นต้องการข้อมูลแบบใด

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/fCN8X5XLW-WFI9W1yvi3K_body-light.png)

## มันทำงานอย่างไร?

::::WorkflowBlock
:::WorkflowBlockItem
นำเข้าไฟล์ OpenAPI ของคุณโดยใช้ **Import Content**:

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/ZIM8Bq-VEqGvv_aHHjArO_import-content-light.png)

หรือใช้ตัวเลือก **Import** จากแต่ละสเปซ:

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/0w0sHacVm8l8N_AFkF4yf_import-option-light.png)

หรือซิงก์ไฟล์ OpenAPI ของคุณโดยตรงจาก [GitHub](docId\:VkbsjWRIlLNfD7bGSBCCQ) repository ของคุณ

ด้วย [การผสานรวม GitHub](docId\:VkbsjWRIlLNfD7bGSBCCQ) คุณสามารถเพิ่มและซิงก์ไฟล์ OpenAPI จาก repository ของคุณได้โดยตรง
:::

:::WorkflowBlockItem
พรีวิวและ [ทดสอบ](docId:3joOjG_Ji7r1WGzrKMkBI) OpenAPI ที่คุณนำเข้า

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/DsF_NDr8yoe62d13qJDP6_test-it-light.png)

พรีวิวและทดสอบ OpenAPI ใหม่ที่คุณนำเข้าด้วยฟีเจอร์ [API ลองใช้!](docId:3joOjG_Ji7r1WGzrKMkBI) ของ Archbee
:::

:::WorkflowBlockItem
**เผยแพร่** หรือ **แชร์** ให้เพื่อนร่วมงานหรือผู้ใช้งานของคุณ!

เผยแพร่ไปยัง Preview หรือโดเมนแบบกำหนดเอง และทำให้พร้อมใช้งานสำหรับทีมและผู้ใช้งานของคุณ 

หากต้องการปกป้องเนื้อหาและแชร์เฉพาะกลุ่ม โปรดดูตัวเลือก [การควบคุมการเข้าถึงสาธารณะ](docId:23P5vUGc9LgzBSgmmd7aj) สำหรับพอร์ทัลที่เผยแพร่แล้ว
:::

:::WorkflowBlockItem
ดูแล ซิงก์ และกำหนดค่า:

1. [ซิงก์ด้วยตนเอง](docId\:FnyQGQHFHvLOH6Jd5KCgF)
2. [ซิงก์อัตโนมัติผ่าน API](docId\:FnyQGQHFHvLOH6Jd5KCgF)
3. [เปลี่ยนภาษาของตัวอย่างโค้ด](docId\:FnyQGQHFHvLOH6Jd5KCgF)
:::
::::

## นี่คือวิดีโอเกี่ยวกับวิธีการทำงาน

::embed[]{url="https://youtu.be/LQ3nEGCcdKg"}