{"id":31912151,"url":"https://github.com/vipwan/biwen.quickapi","last_synced_at":"2025-10-13T17:53:45.283Z","repository":{"id":195961332,"uuid":"694268627","full_name":"vipwan/Biwen.QuickApi","owner":"vipwan","description":"Biwen.QuickApi, WebApi,REPR,Headless CMS","archived":false,"fork":false,"pushed_at":"2025-07-31T10:44:39.000Z","size":12044,"stargazers_count":30,"open_issues_count":7,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-18T02:54:01.760Z","etag":null,"topics":["endpoint","headless-cms","minimal-api","netcore","repr","webapi"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vipwan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-09-20T16:52:10.000Z","updated_at":"2025-07-31T10:44:47.000Z","dependencies_parsed_at":"2023-09-22T06:10:48.342Z","dependency_job_id":"30b4b121-2048-489e-bbc0-db0942730948","html_url":"https://github.com/vipwan/Biwen.QuickApi","commit_stats":null,"previous_names":["vipwan/biwen.quickapi"],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/vipwan/Biwen.QuickApi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vipwan%2FBiwen.QuickApi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vipwan%2FBiwen.QuickApi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vipwan%2FBiwen.QuickApi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vipwan%2FBiwen.QuickApi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vipwan","download_url":"https://codeload.github.com/vipwan/Biwen.QuickApi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vipwan%2FBiwen.QuickApi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279016352,"owners_count":26085829,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["endpoint","headless-cms","minimal-api","netcore","repr","webapi"],"created_at":"2025-10-13T17:53:38.851Z","updated_at":"2025-10-13T17:53:45.272Z","avatar_url":"https://github.com/vipwan.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Biwen.QuickApi\n\n![Nuget](https://img.shields.io/nuget/v/Biwen.QuickApi)\n![Nuget](https://img.shields.io/nuget/dt/Biwen.QuickApi)\n[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/vipwan/Biwen.QuickApi/blob/master/LICENSE.txt) \n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/vipwan/Biwen.QuickApi/pulls) \n\n## 项目介绍\n[临时文档地址](http://39.108.3.212:8086/index.html) \u003cbr/\u003e\nBiwen.QuickApi 2+,是一个微型`aspnetcore`开发框架,提供minimalapi的QuickApi封装,提供`IQuickEndpoint`书写minimalapi,\n模块化支持`Modular`,`多租户`,发布订阅:`IEvent`,作业调度:`IScheduleTask`,审计:`Auditing`,缓存,LocalLock,`OpenApi` ~~\n\n## 实际应用与示例项目\n\n### 提供MySurvey问卷调查示例项目\n点击访问示例项目:[MySurvey](https://github.com/vipwan/MySurvey) - 一个基于 Biwen.QuickApi 构建的完整问卷调查系统，展示了框架在实际业务场景中的应用。\n\n### 提供 Headless CMS模块组件\n[Biwen.QuickApi.Contents](https://github.com/vipwan/Biwen.QuickApi/tree/master/extensions/Biwen.QuickApi.Contents) - 一个强大的无头CMS扩展，提供以下功能：\n\n- 灵活的内容模型定义系统\n- 多种字段类型支持（文本、Markdown、数字、日期、图片等）\n- 内容版本控制和审计跟踪\n- 内容渲染服务与自定义视图模板\n- 通过Slug友好URL访问内容\n- 完整的内容API（创建、查询、更新、删除、预览）\n- 内容状态工作流（草稿、发布、归档）\n- 基于`Elasticsearch`的全文搜索支持\n\n## 代码示例\n\n### 基础QuickApi示例\n\n```c#\npublic class MyStore\n{\n    public static Todo[] SampleTodos()\n    {\n        return [new(1, \"Walk the dog\"), new(2, \"Buy groceries\")];\n    }\n}\n\n[QuickApi(\"todos\")] // 映射到 /api/todos\npublic class TodoApi : BaseQuickApi\u003cEmptyRequest,Todo[]\u003e\n{\n    public override async ValueTask\u003cTodo[]\u003e ExecuteAsync(EmptyRequest request)\n    {\n        await Task.CompletedTask;\n        return MyStore.SampleTodos();\n    }\n}\n```\n\n### 带参数的API示例\n\n```c#\npublic class CreateTodoRequest : BaseRequest\u003cCreateTodoRequest\u003e\n{\n    [Required]\n    public string Title { get; set; } = null!;\n    \n    public bool IsCompleted { get; set; }\n}\n\n[QuickApi(\"todos\", Verbs = Verb.POST)]\n[OpenApiMetadata(\"创建待办事项\", \"添加一个新的待办事项到系统\")]\npublic class CreateTodoApi : BaseQuickApi\u003cCreateTodoRequest, Todo\u003e\n{\n    private readonly ITodoService _todoService;\n    \n    public CreateTodoApi(ITodoService todoService)\n    {\n        _todoService = todoService;\n    }\n    \n    public override async ValueTask\u003cTodo\u003e ExecuteAsync(CreateTodoRequest request, CancellationToken cancellationToken)\n    {\n        return await _todoService.CreateAsync(request.Title, request.IsCompleted);\n    }\n}\n```\n\n### 使用事件系统示例\n\n```c#\n// 定义事件\npublic record TodoCreatedEvent(Todo Todo) : IEvent;\n\n// 发布事件\n[QuickApi(\"todos\", Verbs = Verb.POST)]\npublic class CreateTodoApi : BaseQuickApi\u003cCreateTodoRequest, Todo\u003e\n{\n    private readonly ITodoService _todoService;\n    private readonly IPublisher _publisher;\n    \n    public CreateTodoApi(ITodoService todoService, IPublisher publisher)\n    {\n        _todoService = todoService;\n        _publisher = publisher;\n    }\n    \n    public override async ValueTask\u003cTodo\u003e ExecuteAsync(CreateTodoRequest request)\n    {\n        var todo = await _todoService.CreateAsync(request.Title, request.IsCompleted);\n        \n        // 发布事件\n        await _publisher.PublishAsync(new TodoCreatedEvent(todo));\n        \n        return todo;\n    }\n}\n\n// 处理事件\n[EventHandler]\npublic class TodoCreatedEventHandler : IEventHandler\u003cTodoCreatedEvent\u003e\n{\n    private readonly ILogger\u003cTodoCreatedEventHandler\u003e _logger;\n    \n    public TodoCreatedEventHandler(ILogger\u003cTodoCreatedEventHandler\u003e logger)\n    {\n        _logger = logger;\n    }\n    \n    public Task HandleAsync(TodoCreatedEvent @event)\n    {\n        _logger.LogInformation(\"新的待办事项已创建: {Title}\", @event.Todo.Title);\n        return Task.CompletedTask;\n    }\n}\n```\n\n## 设计理念与特点\n\n- **REPR设计模式**：Biwen.QuickApi遵循 REPR 设计（Request-Endpoint-Response），使API开发结构清晰\n- **开箱即用**：内置常用功能，无需额外配置即可使用\n- **模块化架构**：通过模块化设计，实现功能的即插即用和业务的清晰分离\n- **强大的扩展性**：通过扩展接口，可以轻松定制和扩展框架功能\n- **约定优于配置**：减少配置代码，提高开发效率\n- **完整的文档支持**：下载项目源代码运行`Biwen.QuickApi.DocSite`项目获取详细文档\n\n## 社区与支持\n\n- 欢迎小伙伴们star\u0026issue共同学习进步 [Biwen.QuickApi](https://github.com/vipwan/Biwen.QuickApi)\n- 关注作者博客: [作者博客](https://www.cnblogs.com/vipwan/)\n\n## 开发工具\n\n- [Visual Studio 2022 17.11.0 +](https://learn.microsoft.com/zh-cn/visualstudio/releases/2022/release-notes-preview)\n- [Visual Studio Code](https://code.visualstudio.com/Download)\n- [Net 9.0.0](https://dotnet.microsoft.com/zh-cn/download/dotnet/9.0)\n\n## 依赖环境\u0026库\n\n- Microsoft.AspNetCore.App\n- [FluentValidation.DependencyInjectionExtensions](https://www.nuget.org/packages/FluentValidation.DependencyInjectionExtensions)\n- [Microsoft.AspNetCore.OpenApi](https://www.nuget.org/packages/Microsoft.AspNetCore.OpenApi/8.0.10)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvipwan%2Fbiwen.quickapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvipwan%2Fbiwen.quickapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvipwan%2Fbiwen.quickapi/lists"}