#Tài liệu API

#Giới thiệu

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

#Cài đặt

Đây là một plugin tích hợp sẵn, không cần cài đặt. Bạn chỉ cần kích hoạt để 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ổng tài liệu API: /api/swagger:get
• Tài liệu API lõi: /api/swagger:get?ns=core
• Tài liệu API của tất cả cá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 cho các bộ sưu tập tùy chỉnh: /api/swagger:get?ns=collections
• Các tài nguyên ${collection} và tài nguyên liên quan ${collection}.${association} được chỉ định: /api/swagger:get?ns=collections/{name}

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

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

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

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

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