#Tài liệu API

#Giới thiệu

Tạo tài liệu HTTP API của NocoBase dựa trên Swagger.

#Cài đặt

Plugin tích hợp sẵn, không cần cài đặt. Chỉ cần kích hoạt là có thể sử dụng.

#Hướng dẫn sử dụng

#Truy cập trang tài liệu API

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

#Tổng quan tài liệu

• Tài liệu API tổng: /api/swagger:get
• Tài liệu API kernel: /api/swagger:get?ns=core
• Tài liệu API của tất cả plugin: /api/swagger:get?ns=plugins
• Tài liệu của từng plugin: /api/swagger:get?ns=plugins/{name}
• Tài liệu API của các collection do người dùng tự định nghĩa: /api/swagger:get?ns=collections
• Tài nguyên ${collection} chỉ định và ${collection}.${association} liên quan: /api/swagger:get?ns=collections/{name}

#Hướng dẫn phát triển

#Cách viết tài liệu swagger cho plugin

Trong thư mục src của plugin, thêm tệp swagger/index.ts với nội dung sau:

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

Để biết chi tiết quy tắc viết, vui lòng tham khảo Tài liệu chính thức của Swagger