openapi.txt•5.77 kB
{"openapi":"3.0.1","info":{"title":"员工管理系统 API","description":"基于Spring Boot + MyBatis的员工信息管理系统API文档","contact":{"name":"开发团队","url":"https://github.com/example/learning","email":"dev@example.com"},"license":{"name":"MIT License","url":"https://opensource.org/licenses/MIT"},"version":"1.0.0"},"servers":[{"url":"http://localhost:10086","description":"本地开发环境"},{"url":"https://api.example.com","description":"生产环境"}],"tags":[{"name":"员工管理","description":"员工信息的增删改查API"}],"paths":{"/api/employees/{userId}":{"get":{"tags":["员工管理"],"summary":"根据ID查询员工","description":"根据员工ID获取单个员工的详细信息","operationId":"getEmployeeById","parameters":[{"name":"userId","in":"path","description":"员工ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1001}],"responses":{"404":{"description":"员工不存在","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Employee"}}}},"200":{"description":"查询成功","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Employee"}}}}}},"put":{"tags":["员工管理"],"summary":"更新员工信息","description":"根据员工ID更新员工信息","operationId":"updateEmployee","parameters":[{"name":"userId","in":"path","description":"员工ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1001}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}},"required":true},"responses":{"404":{"description":"员工不存在","content":{"*/*":{"schema":{"type":"boolean"}}}},"200":{"description":"更新成功","content":{"*/*":{"schema":{"type":"boolean"}}}}}},"delete":{"tags":["员工管理"],"summary":"删除员工","description":"根据员工ID删除员工信息","operationId":"deleteEmployee","parameters":[{"name":"userId","in":"path","description":"员工ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1001}],"responses":{"404":{"description":"员工不存在","content":{"*/*":{"schema":{"type":"boolean"}}}},"200":{"description":"删除成功","content":{"*/*":{"schema":{"type":"boolean"}}}}}}},"/api/employees":{"get":{"tags":["员工管理"],"summary":"查询所有员工","description":"获取系统中所有员工的列表信息","operationId":"getAllEmployees","responses":{"200":{"description":"查询成功","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Employee"}}}}}},"post":{"tags":["员工管理"],"summary":"新增员工","description":"添加新的员工信息到系统中","operationId":"addEmployee","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}},"required":true},"responses":{"200":{"description":"新增成功","content":{"*/*":{"schema":{"type":"boolean"}}}},"400":{"description":"请求参数错误","content":{"*/*":{"schema":{"type":"boolean"}}}}}}},"/api/employees/sync":{"get":{"tags":["员工管理"],"summary":"同步员工数据","description":"从JSON文件同步员工数据到数据库","operationId":"syncEmployee","responses":{"500":{"description":"同步失败","content":{"*/*":{"schema":{"type":"boolean"}}}},"200":{"description":"同步成功","content":{"*/*":{"schema":{"type":"boolean"}}}}}}},"/api/employees/search":{"get":{"tags":["员工管理"],"summary":"条件搜索员工","description":"根据姓氏、在职状态、级别等条件搜索员工","operationId":"searchEmployees","parameters":[{"name":"lastName","in":"query","description":"员工姓氏","required":false,"schema":{"type":"string"},"example":"张"},{"name":"isActive","in":"query","description":"在职状态","required":false,"schema":{"type":"boolean"},"example":true},{"name":"level","in":"query","description":"员工级别","required":false,"schema":{"type":"string","format":"byte"},"example":3}],"responses":{"200":{"description":"查询成功","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Employee"}}}}}}},"/api/employees/level/{level}":{"get":{"tags":["员工管理"],"summary":"根据级别查询员工","description":"根据员工级别查询所有符合条件的员工","operationId":"getEmployeesByLevel","parameters":[{"name":"level","in":"path","description":"员工级别","required":true,"schema":{"type":"string","format":"byte"},"example":3}],"responses":{"200":{"description":"查询成功","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Employee"}}}}}}},"/api/employees/active":{"get":{"tags":["员工管理"],"summary":"查询在职员工","description":"获取所有在职状态的员工列表","operationId":"getActiveEmployees","responses":{"200":{"description":"查询成功","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Employee"}}}}}}}},"components":{"schemas":{"Employee":{"type":"object","properties":{"userId":{"type":"integer","description":"员工ID","format":"int32","example":1001},"firstName":{"type":"string","description":"员工名字","example":"三"},"lastName":{"type":"string","description":"员工姓氏","example":"张"},"salary":{"type":"number","description":"员工工资","example":8000.0},"currency":{"type":"string","description":"货币单位","example":"CNY","enum":["CNY","USD","EUR"]},"birthdate":{"type":"string","description":"员工生日","format":"date","example":"1990-01-01"},"isActive":{"type":"boolean","description":"在职状态","example":true},"level":{"maximum":12,"minimum":0,"type":"string","description":"员工级别","format":"byte","example":"Mw=="},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"}},"description":"员工信息实体"}}}}