From f3a1b2d334d0c4e90966a9e13d0ddd47aa4ab4b7 Mon Sep 17 00:00:00 2001 From: feijie Date: Wed, 11 Dec 2024 10:41:23 +0800 Subject: [PATCH] =?UTF-8?q?feat(docs):=20=E6=B7=BB=E5=8A=A0=E5=8A=9F?= =?UTF-8?q?=E8=83=BD=E7=AE=A1=E7=90=86=E6=A8=A1=E5=9D=97=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../README.EN.md | 69 +++++++++++++++++++ .../README.md | 69 +++++++++++++++++++ .../README.EN.md | 44 ++++++++++++ .../README.md | 44 ++++++++++++ .../README.EN.md | 56 +++++++++++++++ .../README.md | 56 +++++++++++++++ 6 files changed, 338 insertions(+) create mode 100644 aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application.Contracts/README.EN.md create mode 100644 aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application.Contracts/README.md create mode 100644 aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application/README.EN.md create mode 100644 aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application/README.md create mode 100644 aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.HttpApi/README.EN.md create mode 100644 aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.HttpApi/README.md diff --git a/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application.Contracts/README.EN.md b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application.Contracts/README.EN.md new file mode 100644 index 000000000..5ea1d98ff --- /dev/null +++ b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application.Contracts/README.EN.md @@ -0,0 +1,69 @@ +# LINGYUN.Abp.FeatureManagement.Application.Contracts + +Feature management application service contract module that defines interfaces, DTOs, and permissions required for feature management. + +## Features + +* Feature Definition Management Interfaces + * IFeatureDefinitionAppService + * Support CRUD operations for feature definitions +* Feature Group Definition Management Interfaces + * IFeatureGroupDefinitionAppService + * Support CRUD operations for feature group definitions +* Complete DTO Definitions + * FeatureDefinitionDto + * FeatureGroupDefinitionDto + * Create, Update, and Query DTOs +* Permission Definitions + * Feature definition management permissions + * Feature group definition management permissions + +## Module Dependencies + +```csharp +[DependsOn( + typeof(AbpFeatureManagementDomainSharedModule), + typeof(VoloAbpFeatureManagementApplicationContractsModule))] +public class AbpFeatureManagementApplicationContractsModule : AbpModule +{ +} +``` + +## Permission Constants + +```csharp +public static class FeatureManagementPermissionNames +{ + public const string GroupName = "FeatureManagement"; + + public static class GroupDefinition + { + public const string Default = GroupName + ".GroupDefinitions"; + public const string Create = Default + ".Create"; + public const string Update = Default + ".Update"; + public const string Delete = Default + ".Delete"; + } + + public static class Definition + { + public const string Default = GroupName + ".Definitions"; + public const string Create = Default + ".Create"; + public const string Update = Default + ".Update"; + public const string Delete = Default + ".Delete"; + } +} +``` + +## Error Codes + +* Error:100001 - Feature definition already exists +* Error:100002 - Feature group definition already exists +* Error:100003 - Cannot delete static feature definition +* Error:100004 - Cannot delete static feature group definition + +## More Information + +* [ABP Feature Management Documentation](https://docs.abp.io/en/abp/latest/Features) +* [ABP Application Services Documentation](https://docs.abp.io/en/abp/latest/Application-Services) + +[简体中文](README.md) diff --git a/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application.Contracts/README.md b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application.Contracts/README.md new file mode 100644 index 000000000..afee323d0 --- /dev/null +++ b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application.Contracts/README.md @@ -0,0 +1,69 @@ +# LINGYUN.Abp.FeatureManagement.Application.Contracts + +功能管理应用服务契约模块，定义了功能管理所需的接口、DTO和权限。 + +## 功能特性 + +* 功能定义管理接口 + * IFeatureDefinitionAppService + * 支持功能定义的CRUD操作 +* 功能组定义管理接口 + * IFeatureGroupDefinitionAppService + * 支持功能组定义的CRUD操作 +* 完整的DTO定义 + * FeatureDefinitionDto + * FeatureGroupDefinitionDto + * 创建、更新和查询DTO +* 权限定义 + * 功能定义管理权限 + * 功能组定义管理权限 + +## 模块依赖 + +```csharp +[DependsOn( + typeof(AbpFeatureManagementDomainSharedModule), + typeof(VoloAbpFeatureManagementApplicationContractsModule))] +public class AbpFeatureManagementApplicationContractsModule : AbpModule +{ +} +``` + +## 权限常量 + +```csharp +public static class FeatureManagementPermissionNames +{ + public const string GroupName = "FeatureManagement"; + + public static class GroupDefinition + { + public const string Default = GroupName + ".GroupDefinitions"; + public const string Create = Default + ".Create"; + public const string Update = Default + ".Update"; + public const string Delete = Default + ".Delete"; + } + + public static class Definition + { + public const string Default = GroupName + ".Definitions"; + public const string Create = Default + ".Create"; + public const string Update = Default + ".Update"; + public const string Delete = Default + ".Delete"; + } +} +``` + +## 错误代码 + +* Error:100001 - 功能定义已存在 +* Error:100002 - 功能组定义已存在 +* Error:100003 - 无法删除静态功能定义 +* Error:100004 - 无法删除静态功能组定义 + +## 更多信息 + +* [ABP功能管理文档](https://docs.abp.io/en/abp/latest/Features) +* [ABP应用服务文档](https://docs.abp.io/en/abp/latest/Application-Services) + +[English](README.EN.md) diff --git a/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application/README.EN.md b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application/README.EN.md new file mode 100644 index 000000000..21e710a6d --- /dev/null +++ b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application/README.EN.md @@ -0,0 +1,44 @@ +# LINGYUN.Abp.FeatureManagement.Application + +Feature management application service module that provides implementation for feature definition management services. + +## Features + +* Feature Definition Management + * Support creating, updating, and deleting feature definitions + * Support feature definition localization + * Support feature definition value type serialization +* Feature Group Definition Management + * Support creating, updating, and deleting feature group definitions + * Support feature group localization +* Support static and dynamic feature definition storage +* Integration with ABP feature management module + +## Module Dependencies + +```csharp +[DependsOn( + typeof(AbpFeatureManagementApplicationContractsModule), + typeof(VoloAbpFeatureManagementApplicationModule))] +public class AbpFeatureManagementApplicationModule : AbpModule +{ +} +``` + +## Permission Definitions + +* FeatureManagement.GroupDefinitions + * FeatureManagement.GroupDefinitions.Create + * FeatureManagement.GroupDefinitions.Update + * FeatureManagement.GroupDefinitions.Delete +* FeatureManagement.Definitions + * FeatureManagement.Definitions.Create + * FeatureManagement.Definitions.Update + * FeatureManagement.Definitions.Delete + +## More Information + +* [ABP Feature Management Documentation](https://docs.abp.io/en/abp/latest/Features) +* [Feature Management Best Practices](https://docs.abp.io/en/abp/latest/Best-Practices/Features) + +[简体中文](README.md) diff --git a/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application/README.md b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application/README.md new file mode 100644 index 000000000..676027f64 --- /dev/null +++ b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.Application/README.md @@ -0,0 +1,44 @@ +# LINGYUN.Abp.FeatureManagement.Application + +功能管理应用服务模块，提供了功能定义的管理服务实现。 + +## 功能特性 + +* 功能定义管理 + * 支持创建、更新、删除功能定义 + * 支持功能定义的本地化 + * 支持功能定义的值类型序列化 +* 功能组定义管理 + * 支持创建、更新、删除功能组定义 + * 支持功能组的本地化 +* 支持静态和动态功能定义存储 +* 集成ABP功能管理模块 + +## 模块依赖 + +```csharp +[DependsOn( + typeof(AbpFeatureManagementApplicationContractsModule), + typeof(VoloAbpFeatureManagementApplicationModule))] +public class AbpFeatureManagementApplicationModule : AbpModule +{ +} +``` + +## 权限定义 + +* FeatureManagement.GroupDefinitions + * FeatureManagement.GroupDefinitions.Create + * FeatureManagement.GroupDefinitions.Update + * FeatureManagement.GroupDefinitions.Delete +* FeatureManagement.Definitions + * FeatureManagement.Definitions.Create + * FeatureManagement.Definitions.Update + * FeatureManagement.Definitions.Delete + +## 更多信息 + +* [ABP功能管理文档](https://docs.abp.io/en/abp/latest/Features) +* [功能管理最佳实践](https://docs.abp.io/en/abp/latest/Best-Practices/Features) + +[English](README.EN.md) diff --git a/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.HttpApi/README.EN.md b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.HttpApi/README.EN.md new file mode 100644 index 000000000..1b8e39a9c --- /dev/null +++ b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.HttpApi/README.EN.md @@ -0,0 +1,56 @@ +# LINGYUN.Abp.FeatureManagement.HttpApi + +Feature management HTTP API module that provides REST API interfaces for feature definition management. + +## Features + +* Feature Definition Management API + * Create, update, delete feature definitions + * Query feature definition list +* Feature Group Definition Management API + * Create, update, delete feature group definitions + * Query feature group definition list +* Localization support +* Integration with ABP feature management module + +## Module Dependencies + +```csharp +[DependsOn( + typeof(AbpFeatureManagementApplicationContractsModule), + typeof(VoloAbpFeatureManagementHttpApiModule))] +public class AbpFeatureManagementHttpApiModule : AbpModule +{ +} +``` + +## API Routes + +### Feature Definitions + +* GET /api/feature-management/definitions +* GET /api/feature-management/definitions/{name} +* POST /api/feature-management/definitions +* PUT /api/feature-management/definitions/{name} +* DELETE /api/feature-management/definitions/{name} + +### Feature Group Definitions + +* GET /api/feature-management/group-definitions +* GET /api/feature-management/group-definitions/{name} +* POST /api/feature-management/group-definitions +* PUT /api/feature-management/group-definitions/{name} +* DELETE /api/feature-management/group-definitions/{name} + +## Localization Configuration + +The module uses ABP's localization system with the following resources: +* AbpFeatureManagementResource +* AbpValidationResource + +## More Information + +* [ABP Web API Documentation](https://docs.abp.io/en/abp/latest/API/Auto-API-Controllers) +* [ABP Feature Management Documentation](https://docs.abp.io/en/abp/latest/Features) + +[简体中文](README.md) diff --git a/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.HttpApi/README.md b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.HttpApi/README.md new file mode 100644 index 000000000..9c8259488 --- /dev/null +++ b/aspnet-core/modules/feature-management/LINGYUN.Abp.FeatureManagement.HttpApi/README.md @@ -0,0 +1,56 @@ +# LINGYUN.Abp.FeatureManagement.HttpApi + +功能管理HTTP API模块，提供了功能定义管理的REST API接口。 + +## 功能特性 + +* 功能定义管理API + * 创建、更新、删除功能定义 + * 查询功能定义列表 +* 功能组定义管理API + * 创建、更新、删除功能组定义 + * 查询功能组定义列表 +* 支持本地化 +* 集成ABP功能管理模块 + +## 模块依赖 + +```csharp +[DependsOn( + typeof(AbpFeatureManagementApplicationContractsModule), + typeof(VoloAbpFeatureManagementHttpApiModule))] +public class AbpFeatureManagementHttpApiModule : AbpModule +{ +} +``` + +## API路由 + +### 功能定义 + +* GET /api/feature-management/definitions +* GET /api/feature-management/definitions/{name} +* POST /api/feature-management/definitions +* PUT /api/feature-management/definitions/{name} +* DELETE /api/feature-management/definitions/{name} + +### 功能组定义 + +* GET /api/feature-management/group-definitions +* GET /api/feature-management/group-definitions/{name} +* POST /api/feature-management/group-definitions +* PUT /api/feature-management/group-definitions/{name} +* DELETE /api/feature-management/group-definitions/{name} + +## 本地化配置 + +模块使用ABP的本地化系统，主要使用以下资源： +* AbpFeatureManagementResource +* AbpValidationResource + +## 更多信息 + +* [ABP Web API文档](https://docs.abp.io/en/abp/latest/API/Auto-API-Controllers) +* [ABP功能管理文档](https://docs.abp.io/en/abp/latest/Features) + +[English](README.EN.md)