@nocobase/plugin-api-doc 1.4.0-alpha.6 → 1.4.0-alpha.8

package/README.md

@@ -1,80 +1,30 @@
-# api-doc
+# NocoBase
 
-English | [中文](./README.zh-CN.md)
+<video width="100%" controls>
+      <source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
+</video>
 
 
-## Introduction
+## What is NocoBase
 
-This plugin is based on `swagger` to write documentation.
+NocoBase is a scalability-first, open-source no-code development platform.  
+Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
 
-## How to access the documentation
+Homepage:  
+https://www.nocobase.com/
 
-1. The access address in the plugin center is `{domain}/admin/settings/api-doc/documentation`
-2. The access address outside the plugin center is `{domain}/api-documentation`
+Online Demo:  
+https://demo.nocobase.com/new
 
-## How to write swagger documentation
+Documents:  
+https://docs.nocobase.com/
 
-> The method in the plugin is the same
+Commericial license & plugins:  
+https://www.nocobase.com/en/commercial
 
-1. `src/swagger.{ts,json}`
-2. `src/swagger/index.{ts,json}`
+License agreement:   
+https://www.nocobase.com/en/agreement
 
-The file paths above can all be traversed to write documentation. Just export your written documentation by default. An example is shown below:
 
-```ts
-export default {
-  info: {
-    title: 'NocoBase API - Api-doc plugin',
-  },
-  tags: [],
-  paths: {},
-  components: {
-    schemas: {}
-  }
-};
-```
-
-Usually, you only need to write **info.title**, **tags**, **paths**, and **components**. Other information such as **server** and **info** are merged into our **base-swagger**.
-
-Base swagger includes the following code:
-
-```ts
-// base swagger
-export default {
-  openapi: '3.0.3',
-  info: {
-    title: 'NocoBase API documentation',
-    description: '',
-    contact: {
-      url: 'https://github.com/nocobase/nocobase/issues',
-    },
-    license: {
-      name: 'Core packages are Apache 2.0 & Plugins packages are AGPL 3.0 licensed.',
-      url: 'https://github.com/nocobase/nocobase#license',
-    },
-  },
-  externalDocs: {
-    description: 'Find out more about NocoBase',
-    url: 'https://docs.nocobase.com/',
-  },
-  components: {
-    securitySchemes: {
-      'api-key': {
-        type: 'http',
-        scheme: 'bearer',
-      },
-    },
-  },
-  security: [
-    {
-      'api-key': [],
-    },
-  ],
-};
-```
-
-> Note that configurations that can only be obtained at runtime, such as the server and version fields, are not filled in the base-swagger.
-
-You can also override these defaults. When writing the swagger documentation for your plugin, you should consider whether your plugin's documentation can be accessed independently.
-
-For detailed swagger writing rules, please refer to the [official documentation](https://swagger.io/docs/specification/about/).
+## Contact Us:  
+hello@nocobase.com

package/dist/externalVersion.js

@@ -8,15 +8,15 @@
  */
 
 module.exports = {
-  "@nocobase/client": "1.4.0-alpha.6",
-  "@nocobase/sdk": "1.4.0-alpha.6",
+  "@nocobase/client": "1.4.0-alpha.8",
+  "@nocobase/sdk": "1.4.0-alpha.8",
   "antd": "5.12.8",
   "react": "18.2.0",
   "@ant-design/icons": "5.2.6",
   "antd-style": "3.7.1",
   "react-i18next": "11.18.6",
-  "@nocobase/actions": "1.4.0-alpha.6",
-  "@nocobase/server": "1.4.0-alpha.6",
-  "@nocobase/utils": "1.4.0-alpha.6",
-  "@nocobase/database": "1.4.0-alpha.6"
+  "@nocobase/actions": "1.4.0-alpha.8",
+  "@nocobase/server": "1.4.0-alpha.8",
+  "@nocobase/utils": "1.4.0-alpha.8",
+  "@nocobase/database": "1.4.0-alpha.8"
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/plugin-api-doc",
-  "version": "1.4.0-alpha.6",
+  "version": "1.4.0-alpha.8",
   "displayName": "API documentation",
   "displayName.zh-CN": "API 文档",
   "description": "An OpenAPI documentation generator for NocoBase HTTP API.",
@@ -23,5 +23,5 @@
     "url": "git+https://github.com/nocobase/nocobase.git",
     "directory": "packages/plugins/api-doc"
   },
-  "gitHead": "7d8583704a1f7ae0caeab72a19fd0bce0a4cec0f"
+  "gitHead": "aa36bd20b2028c5e133a59e922c2f1ab22c86dde"
 }

package/README.zh-CN.md

@@ -1,79 +0,0 @@
-# api-doc
-
-[English](./README.md) | 中文
-
-## 简介
-
-该插件基于 `swagger` 编写文档。
-
-## 如何访问文档
-
-1. 在插件中心访问地址是 `{domain}/admin/settings/api-doc/documentation`
-2. 在插件中心外访问地址是 `{domain}/api-documentation`
-
-## 如何编写 swagger 文档
-
-> 插件内方式一样
-
-1. `src/swagger.{ts,json}`
-2. `src/swagger/index.{ts,json}`
-
-上面的文件路径均可遍写文档，只需最后将您编写的文档默认导出即可，例子如下：
-
-```ts
-export default {
-  info: {
-    title: 'NocoBase API - Auth plugin',
-  },
-  tags: [],
-  paths: {},
-  components: {
-    schemas: {}
-  }
-};
-```
-
-通常你只需要编写 **info.title**, **tags**, **paths**, **components** 即可其他内容如 **server**, **info** 的其他信息都合并我们的 **base-swagger**.
-
-base swagger 包含如下代码
-```ts
-// base swagger
-export default {
-  openapi: '3.0.3',
-  info: {
-    title: 'NocoBase API documentation',
-    description: '',
-    contact: {
-      url: 'https://github.com/nocobase/nocobase/issues',
-    },
-    license: {
-      name: 'Core packages are Apache 2.0 & Plugins packages are AGPL 3.0 licensed.',
-      url: 'https://github.com/nocobase/nocobase#license',
-    },
-  },
-  externalDocs: {
-    description: 'Find out more about NocoBase',
-    url: 'https://docs.nocobase.com/',
-  },
-  components: {
-    securitySchemes: {
-      'api-key': {
-        type: 'http',
-        scheme: 'bearer',
-      },
-    },
-  },
-  security: [
-    {
-      'api-key': [],
-    },
-  ],
-};
-
-```
-
-> 注意：涉及到运行时才能获取的配置，并没有填写在 base-swagger 里，如 server, version 字段
-
-这些默认的配置你同样也可以覆盖它，在你编写插件的 `swagger` 文档时，你需要视你的插件文档是独立的文档，可以被单独访问。
-
-详细的 `swagger` 编写规则请参考[官方文档](https://swagger.io/docs/specification/about/)