mirror of
https://github.com/nocobase/nocobase
synced 2024-11-16 09:45:18 +00:00
705b7449f0
* refactor: plugin manager page
* fix: bug
* feat: addByNpm api
* fix: improve the addByNpm
* feat: improve applicationPlugins:list api
* fix: re-download npm package when restart app
* fix: plugin delete api
* feat: plugin detail api
* feat: zipUrl add api
* fix: upload api bug
* fix: plugin detail info
* feat: upgrade api
* fix: upload api
* feat: handle plugin load error
* feat: support authToken
* feat: muti lang
* fix: build error
* fix: self review
* Update plugin-manager.ts
* fix: bug
* fix: bug
* fix: bug
* fix: bug
* fix: bug
* fix: bugs
* fix: detail click and remove isOfficial
* fix: upgrade no refresh
* fix: file size and type check
* fix: bug
* fix: upgrade error
* fix: bug
* fix: bug
* fix: plugin card layout
* fix: handling exceptional cases
* fix: tgz file support
* fix: macos compress file
* fix: bug
* fix: bug
* fix: bug
* fix: bug
* fix: add upgrade npm type
* fix: bugs
* fix: bug
* fix: change plugins static expose url
* fix: api prefix
* fix: bug
* fix: add nginx `/static/plugin/` path
* fix: bugs and pr docker build no dts
* fix: bug
* fix: build tools bug
* fix: improve code
* fix: build bug
* feat: improve plugin info
* fix: ui bug
* fix: plugin document bug
* feat: improve code
* feat: improve code
* feat: process dev deps check
* feat: improve code
* feat: process.env.IS_DEV_CMD
* fix: do not delete the plugin package
* feat: plugin symlink
* fix: tsx watch --ignore=./storage/plugins/**
* fix: test error
* fix: improve code
* fix: improve code
* fix: emitStartedEvent
* fix: improve code
* fix: type error
* fix: test error
* test: console.log
* fix: createStoragePluginSymLink
* fix: clientStaticMiddleware rename to clientStaticUtils
* feat: build tools support plugins folder
* fix: 350px
* fix: error
* feat: client dev support plugin folder
* fix: clear cli options
* fix: typeError: Converting circular structure to JSON
* fix: plugin name
* chore: restart application after command
* feat: upgrade error & docs
* Update v14-changelog.md
* Update v14-changelog.md
* Update v14-changelog.md
* fix: gateway test
* refactor(plugin-workflow): add ready state for gracefully tearing down
* Revert "chore: restart application after command"
This reverts commit 5015274f8e
.
* chore: stop application whe restart
* T 1218 change plugin folder (#2629)
* feat: change folder name
* feat: change `pm create` command
* feat: revert plugin name change
* fix: delete samples
* feat: change plugins folder
* fix: pm create
* feat: update docs
* fix: link package error
* fix: docs
* fix: create command
* fix: pm add error
* fix: create add build
* fix: pm creatre + add
* feat: add tar command
* fix: docs
* fix: bug
* fix: docs
---------
Co-authored-by: chenos <chenlinxh@gmail.com>
* feat: docs
* Update your-fisrt-plugin.md
* Update your-fisrt-plugin.md
* chore: application reload
* chore: test
* fix: pm add error
* chore: preset install skip exists plugin
* fix: createIfNotExists
---------
Co-authored-by: chenos <chenlinxh@gmail.com>
Co-authored-by: chareice <chareice@live.com>
Co-authored-by: Zhou <zhou.working@gmail.com>
Co-authored-by: mytharcher <mytharcher@gmail.com>
81 lines
2.1 KiB
Markdown
81 lines
2.1 KiB
Markdown
# api-doc
|
|
|
|
English | [中文](./README.zh-CN.md)
|
|
|
|
|
|
## Introduction
|
|
|
|
This plugin is based on `swagger` to write documentation.
|
|
|
|
## How to access the documentation
|
|
|
|
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`
|
|
|
|
## How to write swagger documentation
|
|
|
|
> The method in the plugin is the same
|
|
|
|
1. `src/swagger.{ts,json}`
|
|
2. `src/swagger/index.{ts,json}`
|
|
|
|
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/).
|