#Dokumentasi API

#Pengenalan

Menghasilkan dokumentasi HTTP API NocoBase berbasis Swagger.

#Instalasi

Plugin bawaan, tidak perlu instalasi. Dapat digunakan setelah diaktifkan.

#Petunjuk Penggunaan

#Akses Halaman Dokumentasi API

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

#Ikhtisar Dokumentasi

• Dokumentasi API keseluruhan: /api/swagger:get
• Dokumentasi API kernel: /api/swagger:get?ns=core
• Dokumentasi API semua Plugin: /api/swagger:get?ns=plugins
• Dokumentasi setiap Plugin: /api/swagger:get?ns=plugins/{name}
• Dokumentasi API collections kustom pengguna: /api/swagger:get?ns=collections
• Sumber daya ${collection} dan ${collection}.${association} terkait: /api/swagger:get?ns=collections/{name}

#Panduan Pengembangan

#Cara Menulis Dokumentasi swagger untuk Plugin

Tambahkan file swagger/index.ts pada folder src Plugin, dengan konten sebagai berikut:

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

Untuk aturan penulisan rinci, lihat Dokumentasi Resmi Swagger