#Dokumentasi API

#Pengantar

Plugin ini menghasilkan dokumentasi API HTTP NocoBase berdasarkan Swagger.

#Instalasi

Ini adalah plugin bawaan, tidak perlu instalasi. Cukup aktifkan untuk menggunakannya.

#Petunjuk Penggunaan

#Mengakses Halaman Dokumentasi API

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

#Ikhtisar Dokumentasi

• Dokumentasi API Total: /api/swagger:get
• Dokumentasi API Inti: /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 untuk koleksi kustom: /api/swagger:get?ns=collections
• Sumber daya ${collection} yang ditentukan dan terkait ${collection}.${association}: /api/swagger:get?ns=collections/{name}

#Panduan Pengembang

#Cara Menulis Dokumentasi Swagger untuk Plugin

Tambahkan file swagger/index.ts di folder src plugin dengan konten sebagai berikut:

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

Untuk aturan penulisan yang lebih detail, silakan merujuk ke Dokumentasi Resmi Swagger.