#เอกสารประกอบ API

#บทนำ

ปลั๊กอินนี้สร้างเอกสารประกอบ HTTP API ของ NocoBase โดยอิงตาม Swagger ครับ/ค่ะ

#การติดตั้ง

ปลั๊กอินนี้เป็นปลั๊กอินในตัว ไม่จำเป็นต้องติดตั้งครับ/ค่ะ เพียงแค่เปิดใช้งานก็สามารถใช้งานได้เลย

#วิธีการใช้งาน

#การเข้าถึงหน้าเอกสารประกอบ API

http://localhost:13000/admin/settings/api-doc/documentation

#ภาพรวมเอกสารประกอบ

• เอกสารประกอบ API ทั้งหมด: /api/swagger:get
• เอกสารประกอบ Core API: /api/swagger:get?ns=core
• เอกสารประกอบ API ของปลั๊กอินทั้งหมด: /api/swagger:get?ns=plugins
• เอกสารประกอบของแต่ละปลั๊กอิน: /api/swagger:get?ns=plugins/{name}
• เอกสารประกอบ API สำหรับคอลเลกชันที่ผู้ใช้กำหนดเอง: /api/swagger:get?ns=collections
• ทรัพยากร ${collection} ที่ระบุและทรัพยากรที่เกี่ยวข้อง ${collection}.${association}: /api/swagger:get?ns=collections/{name}

#คู่มือสำหรับนักพัฒนา

#วิธีการเขียนเอกสารประกอบ Swagger สำหรับปลั๊กอิน

ให้เพิ่มไฟล์ swagger/index.ts ในโฟลเดอร์ src ของปลั๊กอิน โดยมีเนื้อหาดังนี้ครับ/ค่ะ:

export default {
  info: {
    title: 'NocoBase API - Auth plugin',
  },
  tags: [],
  paths: {},
  components: {
    schemas: {},
  },
};

สำหรับกฎการเขียนโดยละเอียด โปรดดู เอกสารประกอบอย่างเป็นทางการของ Swagger ครับ/ค่ะ