{ "openapi": "3.0.3", "info": { "title": "无状态会员管理", "version": "1.0.0", "description": "无状态会员管理相关接口文档" }, "paths": { "/api/stateless-members": { "get": { "summary": "获取无状态会员列表", "description": "分页获取无状态会员列表", "parameters": [ { "name": "pageNum", "in": "query", "required": false, "schema": { "type": "number" }, "description": "页码，默认1" }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "number" }, "description": "每页数量，默认10" }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" }, "description": "会员名称关键词" }, { "name": "code", "in": "query", "required": false, "schema": { "type": "string" }, "description": "会员编码" }, { "name": "memberTypeId", "in": "query", "required": false, "schema": { "type": "string" }, "description": "按会员类型ID筛选（会员类型管理记录的_id）" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "number" }, "description": "状态过滤" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "获取成功", "data": { "list": [ { "id": 1, "code": "SM0001", "name": "开放平台会员", "secretKey": "sk-xxx", "memberTypeId": "xxx", "status": 1 } ], "total": 100, "pageNum": 1, "pageSize": 10 } } } } } } } }, "post": { "summary": "创建无状态会员", "description": "创建新的无状态会员", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "string｜必填，会员名称" }, "memberTypeId": { "type": "string", "description": "string｜可选，会员类型ID（会员类型管理记录的_id），如果提供会校验会员类型是否存在" }, "effectiveDate": { "type": "string", "description": "string｜必填，生效日期" }, "validityDays": { "type": "number", "description": "number｜必填，有效期天数（最小7天）" }, "firstEffectiveDate": { "type": "string", "description": "string｜可选，首次生效日期" }, "status": { "type": "number", "description": "number｜可选，状态：1-有效，0-无效，默认0" } }, "required": [ "name", "effectiveDate", "validityDays" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "创建无状态会员成功", "data": { "id": 1, "code": "SM0001", "name": "开放平台会员", "secretKey": "sk-xxx", "memberTypeId": "xxx", "status": 1 } }, "failure": { "code": "4000", "message": "关联的会员类型不存在", "data": null } } } } } } } }, "/api/stateless-members/{id}": { "get": { "summary": "获取无状态会员详情", "description": "根据无状态会员ID获取详细信息", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "无状态会员ID" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "获取成功", "data": { "id": 1, "code": "SM0001", "name": "开放平台会员", "secretKey": "sk-xxx", "memberTypeId": "xxx", "status": 1 } }, "failure": { "code": "4040", "message": "无状态会员不存在", "data": null } } } } } } }, "put": { "summary": "更新无状态会员", "description": "更新指定无状态会员的信息", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "无状态会员ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "string｜可选，会员名称" }, "memberTypeId": { "type": "string", "description": "string｜可选，会员类型ID（会员类型管理记录的_id），如果提供会校验会员类型是否存在" }, "effectiveDate": { "type": "string", "description": "string｜可选，生效日期" }, "validityDays": { "type": "number", "description": "number｜可选，有效期天数（最小7天）" }, "firstEffectiveDate": { "type": "string", "description": "string｜可选，首次生效日期" }, "status": { "type": "number", "description": "number｜可选，状态：1-有效，0-无效" } } } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "更新无状态会员成功", "data": { "id": 1, "code": "SM0001", "name": "开放平台会员", "secretKey": "sk-xxx", "memberTypeId": "xxx", "status": 1 } }, "failure": { "code": "4000", "message": "关联的会员类型不存在", "data": null } } } } } } }, "delete": { "summary": "删除无状态会员", "description": "删除指定的无状态会员", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "无状态会员ID" } ], "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "删除无状态会员成功", "data": { "result": true } }, "failure": { "code": "4000", "message": "删除无状态会员失败", "data": null } } } } } } } }, "/api/stateless-members/{id}/status": { "put": { "summary": "切换无状态会员状态", "description": "切换无状态会员的启用/禁用状态", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "无状态会员ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number", "description": "number｜必填，状态：1-有效，0-无效" } }, "required": [ "status" ] } } } }, "responses": { "200": { "description": "成功响应", "content": { "application/json": { "example": { "success": { "code": "0000", "message": "状态更新成功", "data": { "id": 1, "code": "SM0001", "name": "开放平台会员", "secretKey": "sk-xxx", "memberTypeId": "xxx", "effectiveDate": "2025-01-01", "validityDays": 365, "firstEffectiveDate": "2025-01-01", "status": 1, "updateTime": "2025-01-01T10:00:00.000Z" } }, "failure": { "code": "4040", "message": "无状态会员不存在", "data": null } } } } } } } } } }