swagger-spec.json

{"openapi":"3.0.0","paths":{"/api-json":{"get":{"operationId":"AppController_code","summary":"获取接口文档json数据","parameters":[],"responses":{"200":{"description":""}}}},"/":{"get":{"operationId":"AppController_getHello","parameters":[],"responses":{"200":{"description":""}}}},"/api/user/init":{"get":{"operationId":"UserController_initData","summary":"初始化用户、角色、权限","parameters":[],"responses":{"200":{"description":""}},"tags":["用户"]}},"/api/user/code":{"get":{"operationId":"UserController_code","summary":"获取图文验证码","parameters":[],"responses":{"200":{"description":""}},"tags":["用户"]}},"/api/user/emailCode":{"get":{"operationId":"UserController_emailCode","summary":"获取邮箱验证码","parameters":[],"responses":{"200":{"description":""}},"tags":["用户"]}},"/api/user/login":{"post":{"operationId":"UserController_login","summary":"用户登录","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginDto"}}}},"responses":{"201":{"description":""}},"tags":["用户"]}},"/api/user/refresh":{"get":{"operationId":"UserController_refresh","summary":"刷新token","parameters":[{"name":"refresh_token","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["用户"]}},"/api/user/register":{"post":{"operationId":"UserController_create","summary":"创建用户","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserDto"}}}},"responses":{"201":{"description":""}},"tags":["用户"]}},"/api/user/{id}":{"delete":{"operationId":"UserController_delete","summary":"删除用户","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"responses":{"200":{"description":""}},"tags":["用户"]},"patch":{"operationId":"UserController_update","summary":"修改用户","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"number"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserDto"}}}},"responses":{"200":{"description":""}},"tags":["用户"]}},"/api/user":{"post":{"operationId":"UserController_findAll","summary":"查找所有用户带分页带keyword","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/findAllUserDto"}}}},"responses":{"201":{"description":""}},"tags":["用户"]}},"/api/menu":{"post":{"operationId":"MenuController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMenuDto"}}}},"responses":{"201":{"description":""}},"tags":["菜单"]},"get":{"operationId":"MenuController_findAll","parameters":[],"responses":{"200":{"description":""}},"tags":["菜单"]}},"/api/menu/{id}":{"get":{"operationId":"MenuController_findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["菜单"]},"patch":{"operationId":"MenuController_update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMenuDto"}}}},"responses":{"200":{"description":""}},"tags":["菜单"]},"delete":{"operationId":"MenuController_remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["菜单"]}},"/api/upload":{"post":{"operationId":"UploadController_upload","summary":"单文件上传","parameters":[],"responses":{"201":{"description":""}},"tags":["上传"]},"get":{"operationId":"UploadController_getAllFile","summary":"查询所有文件","parameters":[],"responses":{"200":{"description":""}},"tags":["上传"]}},"/api/upload/uploadFile":{"post":{"operationId":"UploadController_uploadFile","summary":"分片上传","parameters":[],"responses":{"201":{"description":""}},"tags":["上传"]}},"/api/upload/merge":{"get":{"operationId":"UploadController_merge","summary":"合并文件","parameters":[{"name":"name","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["上传"]}},"/api/upload/addFile":{"post":{"operationId":"UploadController_create","summary":"将上传的文件的对应关系存储到数据库","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFileDto"}}}},"responses":{"201":{"description":""}},"tags":["上传"]}},"/api/upload/{id}":{"get":{"operationId":"UploadController_getFile","summary":"根据id查询文件","parameters":[],"responses":{"200":{"description":""}},"tags":["上传"]},"delete":{"operationId":"UploadController_deleteFile","summary":"删除文件","parameters":[],"responses":{"200":{"description":""}},"tags":["上传"]}},"/api/upload/download/{id}":{"get":{"operationId":"UploadController_export","summary":"下载文件","parameters":[],"responses":{"200":{"description":""}},"tags":["上传"]}}},"info":{"title":"template-nest","description":"","version":"1.0","contact":{}},"tags":[],"servers":[],"components":{"schemas":{"LoginDto":{"type":"object","properties":{"userName":{"type":"string","description":"用户名","example":"admin"},"email":{"type":"string","description":"邮箱","example":"email@qq.com"},"password":{"type":"string","description":"密码","example":"123456"},"code":{"type":"string","description":"验证码"}},"required":["userName","email","password","code"]},"CreateUserDto":{"type":"object","properties":{"id":{"type":"number","description":"用户id","example":1},"userName":{"type":"string","description":"用户名","example":"admin"},"password":{"type":"string","description":"密码","example":"123456"},"email":{"type":"string","description":"邮箱","example":"1640551913@qq.com"},"role":{"type":"number","description":"角色","example":"1"},"phone":{"type":"string","description":"手机号","example":"13888888888"},"state":{"type":"number","description":"状态","example":1}},"required":["id","userName","password","email","role","phone","state"]},"UpdateUserDto":{"type":"object","properties":{"id":{"type":"number","description":"用户id","example":1},"userName":{"type":"string","description":"用户名","example":"admin"},"password":{"type":"string","description":"密码","example":"123456"},"email":{"type":"string","description":"邮箱","example":"1640551913@qq.com"},"role":{"type":"number","description":"角色","example":"1"},"phone":{"type":"string","description":"手机号","example":"13888888888"},"state":{"type":"number","description":"状态","example":1}}},"findAllUserDto":{"type":"object","properties":{"page":{"type":"number","description":"页码","example":1},"pageSize":{"type":"number","description":"每页条数","example":10},"keyWord":{"type":"string","description":"密码","example":""}},"required":["page","pageSize","keyWord"]},"CreateMenuDto":{"type":"object","properties":{"menuId":{"type":"number","description":"菜单id","example":1},"parentMenuId":{"type":"number","description":"父菜单id","example":1},"title":{"type":"string","description":"菜单名"},"path":{"type":"string","description":"URL路径"},"name":{"type":"string","description":"标题"},"component":{"type":"string","description":"组件路径"},"redirect":{"type":"string","description":"重定向"},"icon":{"type":"string","description":"图标"},"hidden":{"type":"boolean","description":"是否隐藏"}},"required":["menuId","parentMenuId","title","path","name","component","redirect","icon","hidden"]},"UpdateMenuDto":{"type":"object","properties":{"menuId":{"type":"number","description":"菜单id","example":1},"parentMenuId":{"type":"number","description":"父菜单id","example":1},"title":{"type":"string","description":"菜单名"},"path":{"type":"string","description":"URL路径"},"name":{"type":"string","description":"标题"},"component":{"type":"string","description":"组件路径"},"redirect":{"type":"string","description":"重定向"},"icon":{"type":"string","description":"图标"},"hidden":{"type":"boolean","description":"是否隐藏"}}},"CreateFileDto":{"type":"object","properties":{"id":{"type":"number","description":"文件id","example":1},"fileName":{"type":"string","description":"文件名"},"desc":{"type":"string","description":"描述"}},"required":["id","fileName","desc"]}}},"externalDocs":{"description":"api-json","url":"http://localhost:9528/api-json"}}