nameczz 9218b44af3 test acion 4 年之前
..
src 9218b44af3 test acion 4 年之前
test c211e8241e init server 4 年之前
.eslintrc.js 62bbfb1f59 add collection api 4 年之前
.gitignore c211e8241e init server 4 年之前
.prettierrc c211e8241e init server 4 年之前
README.md 4429e517ca add server readme 4 年之前
generate-csv.ts d901494c0a add created time in collection 4 年之前
nest-cli.json 6b1ce97106 update some docs for swagger 4 年之前
package.json d901494c0a add created time in collection 4 年之前
tsconfig.build.json c211e8241e init server 4 年之前
tsconfig.json 62bbfb1f59 add collection api 4 年之前
yarn.lock d901494c0a add created time in collection 4 年之前

README.md

Milvus insight server

Milvus insight server use nest

Milvus insight server depend on milvus2-node-sdk to operate milvus data.

How to run

  1. yarn install
  2. yarn start:dev

Folder Structure

.
├── auth                    # Jwt authentication not useful for now
├── collections             # Manage milvus collections api
├── interceptors            # Nest interceptors related
├── middlewares             # Nest middlewares related
├── milvus                  # Milvus itself infomation api. Every other api modules need import this module.
├── partitions              # Manage milvus partitions api
├── pipe                    # Nest pipe related
├── schema                  # Manage milvus schema api
├── users                   # Working with auth module, not useful for now.
├── utils                   # Common helping functions.
├── app.xxx.ts              # Need import all other modules to app module.
└── main.ts                 # Usually we dont need change this.

How to create new module

  1. nest g module your-module-name
  2. nest g service your-module-name
  3. nest g controller your-module-name

Api validation

We use class-validator to help us. So normally we have dto.ts for every controller file.

Swagger Doc

We need use ApiProperty to tag every field in dto.ts file and use ApiTags in every controller file. After you start server, you can http://localhost:3000/api to see swagger doc.