visitor-node-api/swagger-spec.json

{"openapi":"3.0.0","paths":{"/":{"get":{"operationId":"AppController_getHello","parameters":[],"responses":{"200":{"description":""}}}},"/doc/json":{"get":{"operationId":"AppController_getDoc","parameters":[],"responses":{"200":{"description":""}}}},"/app.config":{"get":{"operationId":"AppController_appConfig","parameters":[],"responses":{"200":{"description":""}}}},"/auth/login/status/is_login":{"get":{"operationId":"AuthController_loginGetStatus","summary":"获取 token 是否失效","parameters":[{"name":"qunsense_code","required":true,"in":"query","description":"小程序码","schema":{"type":"string"}}],"responses":{"200":{"description":"返回参数说明","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginStatus"}}}}},"tags":["用户登录"]}},"/users/viewer":{"get":{"operationId":"UserController_viewer","summary":"获取个人信息","parameters":[],"responses":{"200":{"description":"返回参数说明"}},"tags":["系统用户"],"security":[{"bearer":[]},{"bearer":[]}]}},"/roles":{"post":{"operationId":"RoleController_create","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoleDto"}}}},"responses":{"201":{"description":""}},"tags":["用户角色"]},"get":{"operationId":"RoleController_findAll","parameters":[],"responses":{"200":{"description":""}},"tags":["用户角色"]}},"/roles/{id}":{"get":{"operationId":"RoleController_findOne","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["用户角色"]},"patch":{"operationId":"RoleController_update","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRoleDto"}}}},"responses":{"200":{"description":""}},"tags":["用户角色"]},"delete":{"operationId":"RoleController_remove","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["用户角色"]}},"/file/upload/public":{"post":{"operationId":"FileController_uploadPublicFile","summary":"上传文件","parameters":[],"requestBody":{"required":true,"description":"file","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/FileUploadType"}}}},"responses":{"201":{"description":""}},"tags":["file"],"security":[{"bearer":[]}]}},"/file/upload/base64":{"post":{"operationId":"FileController_louploadBase64Filegin","summary":"上传头像文件","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Base64File"}}}},"responses":{"201":{"description":""}},"tags":["file"],"security":[{"bearer":[]}]}}},"info":{"title":"restfull api","description":"\n  Api为restfull风格api，接口请求成功与否请使用header里面的status来判断，200表示get请求成功，201表示POST/PUT/PATCH请求成功 \n  204表示delete成功，非上述code返回体会有message字段，表示请求失败的错误描述，例如：header的status=500 那么返回体中回包含{message:\"Internal server error\"}\n  注意，返回的message字段并不一定是string类型。注意：orm使用的是固定版本typeorm@0.3.15。表结构存在关联字段，更高版本每次都会重建主键id字段，无论关联字段类型是uuid还是vachar(36)\n  重建时会删除id对应的值，导致外建关联报错“ER_NO_REFERENCED_ROW2：can not add or update a children row:xx\n  ","version":"1.0","contact":{},"license":{"name":"2019 © shijianhuoban","url":"https://github.com/shijianhuoban"}},"tags":[],"servers":[],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"LoginStatus":{"type":"object","properties":{"status":{"type":"boolean","description":"登录状态返回"}}},"CreateRoleDto":{"type":"object","properties":{}},"UpdateRoleDto":{"type":"object","properties":{}},"FileUploadType":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"required":["file"]},"Base64File":{"type":"object","properties":{"base64":{"type":"string"}},"required":["base64"]}}}}