AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

[ABP框架]动态web Api的拦截用法。

2017-06-30 1882
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 先进行配置首先这种需求，一般发生在APP端，我们给APP，不会给所有项目系统的接口给他们用。我们系统有200个接口，但是APP的需求只会用20个。那么这个需求也就应运而生了。

先进行配置

首先这种需求，一般发生在APP端，我们给APP，不会给所有项目系统的接口给他们用。我们系统有200个接口，但是APP的需求只会用20个。那么这个需求也就应运而生了。

img_7038b506c2e564e6c9a65a2cfdd0b862.png
项目结构.png

以上为API文件夹中为项目接口，没有啥特别复杂的东西存在。

首先创建好，一个网站项目，进行模块的配置。
首先引入以下的nuget包：
以下是WebApp项目中的packages.config

<?xml version="1.0" encoding="utf-8"?>
<packages>
  <package id="Abp" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Castle.Log4Net" version="1.5.1" targetFramework="net452" />
  <package id="Abp.EntityFramework" version="1.5.1" targetFramework="net452" />
  <package id="Abp.EntityFramework.Common" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Owin" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Api" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Common" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Mvc" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Resources" version="1.5.2" targetFramework="net452" />
  <package id="Abp.Zero" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Zero.EntityFramework" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Zero.Owin" version="1.5.1" targetFramework="net452" />
  <package id="Antlr" version="3.5.0.2" targetFramework="net452" />
  <package id="bootstrap" version="3.0.0" targetFramework="net452" />
  <package id="Castle.Core" version="3.3.3" targetFramework="net452" />
  <package id="Castle.LoggingFacility" version="3.4.0" targetFramework="net452" />
  <package id="Castle.Windsor" version="3.4.0" targetFramework="net452" />
  <package id="EntityFramework" version="6.1.3" targetFramework="net452" />
  <package id="EntityFramework.DynamicFilters" version="1.4.11" targetFramework="net452" />
  <package id="JetBrains.Annotations" version="10.4.0" targetFramework="net452" />
  <package id="jQuery" version="1.6.4" targetFramework="net452" />
  <package id="log4net" version="2.0.8" targetFramework="net452" />
  <package id="Microsoft.AspNet.Identity.Core" version="2.2.1" targetFramework="net452" />
  <package id="Microsoft.AspNet.Identity.Owin" version="2.2.1" targetFramework="net452" />
  <package id="Microsoft.AspNet.Mvc" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.Mvc.zh-Hans" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.Razor" version="3.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.Razor.zh-Hans" version="3.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.Web.Optimization" version="1.1.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.Web.Optimization.zh-Hans" version="1.1.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Client" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Client.zh-Hans" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Core" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Core.zh-Hans" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.HelpPage" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Owin" version="5.2.3" targetFramework="net461" />
  <package id="Microsoft.AspNet.WebApi.WebHost" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.WebHost.zh-Hans" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebPages" version="3.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebPages.zh-Hans" version="3.2.3" targetFramework="net452" />
  <package id="Microsoft.Bcl" version="1.1.10" targetFramework="net452" />
  <package id="Microsoft.Bcl.Async" version="1.0.168" targetFramework="net452" />
  <package id="Microsoft.Bcl.Build" version="1.0.21" targetFramework="net452" />
  <package id="Microsoft.CodeDom.Providers.DotNetCompilerPlatform" version="1.0.3" targetFramework="net452" />
  <package id="Microsoft.Net.Compilers" version="1.3.2" targetFramework="net452" developmentDependency="true" />
  <package id="Microsoft.Owin" version="3.1.0" targetFramework="net452" />
  <package id="Microsoft.Owin.FileSystems" version="3.0.1" targetFramework="net452" />
  <package id="Microsoft.Owin.Host.SystemWeb" version="3.0.1" targetFramework="net452" />
  <package id="Microsoft.Owin.Security" version="3.1.0" targetFramework="net452" />
  <package id="Microsoft.Owin.Security.Cookies" version="3.0.1" targetFramework="net452" />
  <package id="Microsoft.Owin.Security.OAuth" version="3.0.1" targetFramework="net452" />
  <package id="Microsoft.Owin.StaticFiles" version="3.0.1" targetFramework="net452" />
  <package id="Microsoft.Web.Infrastructure" version="1.0.0.0" targetFramework="net452" />
  <package id="Modernizr" version="2.8.3" targetFramework="net452" />
  <package id="Newtonsoft.Json" version="9.0.1" targetFramework="net452" />
  <package id="Nito.AsyncEx" version="4.0.1" targetFramework="net452" />
  <package id="Owin" version="1.0" targetFramework="net452" />
  <package id="Respond" version="1.2.0" targetFramework="net452" />
  <package id="Swashbuckle.Core" version="5.5.3" targetFramework="net461" />
  <package id="System.Collections.Immutable" version="1.3.1" targetFramework="net452" />
  <package id="System.Linq.Dynamic" version="1.0.7" targetFramework="net452" />
  <package id="WebGrease" version="1.6.0" targetFramework="net452" />
</packages>

新建一个'AbpProjectTemplateWebAppModule.cs' 的类文件：

  [DependsOn(
        typeof(AbpWebMvcModule),
        typeof(AbpZeroOwinModule),
        typeof(AbpProjectTemplateDataModule),
           typeof(AbpProjectTemplateWebAppApiModule),

        typeof(AbpProjectTemplateApplicationModule)

    )]
    public class AbpProjectTemplateWebAppModule : AbpModule
    {
        public override void PreInitialize()
        {
           
        }
        public override void Initialize()
        {
            //进行以来注入
            IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());

            IocManager.IocContainer.Register(
                Component
                    .For<IAuthenticationManager>()
                    .UsingFactoryMethod(() => HttpContext.Current.GetOwinContext().Authentication)
                    .LifestyleTransient()
            );
            //Areas
            AreaRegistration.RegisterAllAreas();

            //Routes
            RouteConfig.RegisterRoutes(RouteTable.Routes);

            //Bundling
            BundleTable.Bundles.IgnoreList.Clear();
            BundleConfig.RegisterBundles(BundleTable.Bundles);
        }
 
    }

对Global.asax文件进行修改，修改后：

    public class WebApiApplication : AbpWebApplication<AbpProjectTemplateWebAppModule>
    {
        protected override void Application_Start(object sender, EventArgs e)
        {
            //Use UTC clock. Remove this to use local time for your application.
             
            //Log4Net configuration
            AbpBootstrapper.IocManager.IocContainer
                .AddFacility<LoggingFacility>(f => f.UseAbpLog4Net()
                    .WithConfig("log4net.config")
                );

            base.Application_Start(sender, e);
        }

       
    }

不要尝试在webapp中，直接引入abp.webapi。我失败了两次，但是之前的0.97版本又是可以的。。

然后创建一个webappapi的类库：
引入如下的nuge包
这个是webAppApi项目中的package.config:

<?xml version="1.0" encoding="utf-8"?>
<packages>
  <package id="Abp" version="1.5.1" targetFramework="net452" />
  <package id="Abp.AutoMapper" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Api" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Web.Common" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Zero" version="1.5.1" targetFramework="net452" />
  <package id="Abp.Zero.Owin" version="1.5.1" targetFramework="net452" />
  <package id="AutoMapper" version="5.2.0" targetFramework="net452" />
  <package id="Castle.Core" version="3.3.3" targetFramework="net461" />
  <package id="Castle.LoggingFacility" version="3.4.0" targetFramework="net452" />
  <package id="Castle.Windsor" version="3.4.0" targetFramework="net452" />
  <package id="JetBrains.Annotations" version="10.4.0" targetFramework="net452" />
  <package id="Microsoft.AspNet.Identity.Core" version="2.2.1" targetFramework="net452" />
  <package id="Microsoft.AspNet.Identity.Owin" version="2.2.1" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Client" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Core" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.Owin" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebApi.WebHost" version="5.2.3" targetFramework="net452" />
  <package id="Microsoft.Bcl" version="1.1.10" targetFramework="net452" />
  <package id="Microsoft.Bcl.Async" version="1.0.168" targetFramework="net452" />
  <package id="Microsoft.Bcl.Build" version="1.0.21" targetFramework="net452" />
  <package id="Microsoft.Owin" version="3.1.0" targetFramework="net461" />
  <package id="Microsoft.Owin.Security" version="3.1.0" targetFramework="net461" />
  <package id="Microsoft.Owin.Security.Cookies" version="3.0.1" targetFramework="net461" />
  <package id="Microsoft.Owin.Security.OAuth" version="3.0.1" targetFramework="net461" />
  <package id="Newtonsoft.Json" version="9.0.1" targetFramework="net452" />
  <package id="Nito.AsyncEx" version="4.0.1" targetFramework="net452" />
  <package id="Owin" version="1.0" targetFramework="net452" />
  <package id="Swashbuckle.Core" version="5.5.3" targetFramework="net452" />
  <package id="System.Collections.Immutable" version="1.3.1" targetFramework="net452" />
  <package id="System.Linq.Dynamic" version="1.0.7" targetFramework="net452" />
</packages>

然后下面就是创建一个"AbpProjectTemplateWebAppApiModule.cs"

 /// <summary>
    /// 在系统中进行WebApi的配置
    /// </summary>
    [DependsOn(typeof(AbpWebApiModule), typeof(AbpProjectTemplateApplicationModule))]
    public class AbpProjectTemplateWebAppApiModule : AbpModule
    {
       
        public override void Initialize()
        {
            IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());           
            Configuration.Modules.AbpWebApi().DynamicApiControllerBuilder
                .ForAll<IApplicationService>(typeof(AbpProjectTemplateApplicationModule).Assembly, "app")
                .Build();
            Configuration.Modules.AbpWebApi().HttpConfiguration.Filters.Add(new HostAuthenticationFilter("Bearer"));      
        }        
    }

然后就是配置EnableSwaggerUi了。这里的教程，请去看：ABP教程-给项目添加SwaggerUI,生成动态webapi

跑起来了后的截图：

img_e897d728bb5a9e42c6482bfb80e07b8e.png
API截图

接口太多了。那么我们就来折腾下
首先在application层创建一个

  /// <summary>
    /// 使用该特性进行app过滤
    ///  
    /// </summary>
    public class WebAppApiAttribute:System.Attribute
    {
        
    }

对AbpProjectTemplateWebAppApiModule中的配置方法进行改造下

Configuration.Modules.AbpWebApi().DynamicApiControllerBuilder
    .ForAll<IApplicationService>(Assembly.GetExecutingAssembly(), "app")
    .ForMethods(builder =>
    {
           if (!a.Method.IsDefined(typeof(WebAppApiAttribute)))
                        {
                            a.DontCreate = true;
                        }
    })
    .Build();

然后在特定的 方法上打上标记。

 public interface ICachingAppService : IApplicationService
    {
        [WebAppApi]
        ListResultDto<CacheDto> GetAllCaches();

        Task ClearCache(EntityDto<string> input);
        [WebAppApi]
        Task ClearAllCaches();
    }

然后我们运行项目，看到如下结果：

img_013d61a6394f38621554ecafd573360b.png
编译后的结果

更多的玩法，请参考官方文档：
Dynamic Web API Layer

https://aspnetboilerplate.com/Pages/Documents/v1.5.2/Dynamic-Web-API

文章标签：
API
Web App开发
关键词：
API Web
web框架
框架web
框架API
web api
wer_ltm
目录
相关文章
光明顶阳顶天
|
2月前
|
API
用 Koa 框架实现一个简单的 RESTful API
用 Koa 框架实现一个简单的 RESTful API
光明顶阳顶天
68 26
大树营养快线
|
2月前
|
开发框架 搜索推荐 数据可视化
Django框架适合开发哪种类型的Web应用程序？
Django 框架凭借其强大的功能、稳定性和可扩展性，几乎可以适应各种类型的 Web 应用程序开发需求。无论是简单的网站还是复杂的企业级系统，Django 都能提供可靠的支持，帮助开发者快速构建高质量的应用。同时，其活跃的社区和丰富的资源也为开发者在项目实施过程中提供了有力的保障。
大树营养快线
65 5
东方睿赢
|
2月前
|
开发框架 JavaScript 前端开发
TypeScript 是一种静态类型的编程语言，它扩展了 JavaScript，为 Web 开发带来了强大的类型系统、组件化开发支持、与主流框架的无缝集成、大型项目管理能力和提升开发体验等多方面优势
TypeScript 是一种静态类型的编程语言，它扩展了 JavaScript，为 Web 开发带来了强大的类型系统、组件化开发支持、与主流框架的无缝集成、大型项目管理能力和提升开发体验等多方面优势。通过明确的类型定义，TypeScript 能够在编码阶段发现潜在错误，提高代码质量；支持组件的清晰定义与复用，增强代码的可维护性；与 React、Vue 等框架结合，提供更佳的开发体验；适用于大型项目，优化代码结构和性能。随着 Web 技术的发展，TypeScript 的应用前景广阔，将继续引领 Web 开发的新趋势。
东方睿赢
50 2
API小知识
|
2月前
|
缓存 API 数据库
Python哪个框架合适开发速卖通商品详情api？
在跨境电商平台速卖通的商品详情数据获取与整合中，Python 语言及其多种框架（如 Flask、Django、Tornado 和 FastAPI）提供了高效解决方案。Flask 简洁灵活，适合快速开发；Django 功能全面，适用于大型项目；Tornado 性能卓越，擅长处理高并发；FastAPI 结合类型提示和异步编程，开发体验优秀。选择合适的框架需综合考虑项目规模、性能要求和团队技术栈。
API小知识
35 2
众所周知
|
2月前
|
中间件 Go API
Go语言中几种流行的Web框架，如Beego、Gin和Echo，分析了它们的特点、性能及适用场景，并讨论了如何根据项目需求、性能要求、团队经验和社区支持等因素选择最合适的框架
本文概述了Go语言中几种流行的Web框架，如Beego、Gin和Echo，分析了它们的特点、性能及适用场景，并讨论了如何根据项目需求、性能要求、团队经验和社区支持等因素选择最合适的框架。
众所周知
155 1
API小知识
|
2月前
|
开发框架 Java 关系型数据库
Java哪个框架适合开发API接口？
在快速发展的软件开发领域，API接口连接了不同的系统和服务。Java作为成熟的编程语言，其生态系统中出现了许多API开发框架。Magic-API因其独特优势和强大功能，成为Java开发者优选的API开发框架。本文将从核心优势、实际应用价值及未来展望等方面，深入探讨Magic-API为何值得选择。
API小知识
81 2
API小知识
|
2月前
|
安全 API 数据库
Python哪个框架合适开发淘宝商品详情api？
在数字化商业时代，开发淘宝商品详情API成为企业拓展业务的重要手段。Python凭借其强大的框架支持，如Flask、Django、Tornado和FastAPI，为API开发提供了多样化的选择。本文探讨了这些框架的特点、优势及应用场景，帮助开发者根据项目需求选择最合适的工具，确保API的高效、稳定与可扩展性。
API小知识
35 0
胡庆访
|
程序员 API
091030 T 焦点在外，框架API设计
框架的设计和API的设计，同样应该有客户服务意识，焦点在外。这时，可以使用TDD的方式先对API的设计进行规定，比较方便程序员间交流。到后期也可用于测试。
胡庆访
889 0
游客7q6odlcu3jr5c
|
1天前
|
JSON 前端开发 搜索推荐
关于商品详情 API 接口 JSON 格式返回数据解析的示例
本文介绍商品详情API接口返回的JSON数据解析。最外层为`product`对象，包含商品基本信息（如id、name、price）、分类信息（category）、图片（images）、属性（attributes）、用户评价（reviews）、库存（stock）和卖家信息（seller）。每个字段详细描述了商品的不同方面，帮助开发者准确提取和展示数据。具体结构和字段含义需结合实际业务需求和API文档理解。
游客7q6odlcu3jr5c
59 37
winx_19970108018
|
7天前
|
JSON API 数据格式
京东商品SKU价格接口（Jd.item_get）丨京东API接口指南
京东商品SKU价格接口（Jd.item_get）是京东开放平台提供的API，用于获取商品详细信息及价格。开发者需先注册账号、申请权限并获取密钥，随后通过HTTP请求调用API，传入商品ID等参数，返回JSON格式的商品信息，包括价格、原价等。接口支持GET/POST方式，适用于Python等语言的开发环境。
winx_19970108018
50 11

热门文章

最新文章

  • 1
    币安(binance)API接口
  • 2
    SpringBoot入门到精通（二十一）如何优雅的设计 RESTful API 接口版本号，实现 API 版本控制！
  • 3
    大数据时代，数据和API 安全性如何保障？
  • 4
    [笔记]Windows核心编程《二十二》注入DLL和拦截API
  • 5
    如何进行安全可靠的API身份验证？
  • 6
    Open API的资源集
  • 7
    数据可视化大屏百度地图区域掩膜MapMask实现地图指定区域非省市县行政区显示的实战案例解析(JavaScript API GL、个性化地图定制、指定区域经纬度拾取转化)
  • 8
    ArcGIS API for Silverlight 当DataGrid选中项时，地图聚焦弹出窗口，并可以播放音频文件
  • 9
    API 接口的对接流程和注意事项
  • 10
    如何设计优秀的 HTML API
  • 1
    web前端之纯CSS实现简单酷炫的照片墙效果、排除元素的伪类、scale
    98
  • 2
    了解常见的web漏洞-XXE漏洞，日常如何做好web安全
    110
  • 3
    Python Web开发主要常用的框架
    231
  • 4
    MVC（模型-视图-控制器）是一种在Web应用程序开发中广泛使用的软件设计模式
    80
  • 5
    Web应用程序的会话管理是一种跟踪和识别特定用户与Web服务器之间交互的技术
    272
  • 6
    在Python Web开发中，测试是一个至关重要的环节
    185
  • 7
    深入探索Spring Boot Web应用源码及实战应用
    119
  • 8
    golang学习7，glang的web的restful接口结构体传参
    64
  • 9
    golang学习6，glang的web的restful接口传参
    61
  • 10
    golang学习5，glang的web的restful接口
    56

    • 相关课程

    更多
  • Python Web开发基础
  • Java Web开发系列课程 - Spring框架入门
  • 企业Web常用架构LAMP-LNMP实战
  • 高校精品课-西安交通大学-Web 编程技术
  • Java Web项目实战 - 图书商城
  • Java面试疑难点解析 - Java Web开发

    • 相关电子书

    更多
  • Spring Boot2.0实战Redis分布式缓存
  • CUDA MATH API
  • API PLAYBOOK

    • 相关实验场景

    更多
  • 1分钟SAE部署Web在线游戏
  • 基于Assistant Api的旅游助手
  • 快速体验智能体API应用
  • 每个IT人都想学的“Web应用上云经典架构”实战
  • 使用SLB+2ECS+NAS，部署电商web网站的高可用架构
  • Html5和Webpack1：Webpack5打包工具介绍
    • 下一篇
    DataWorks智能交互式数据开发与分析之旅