coco/api-policy-component

Api Policy Component

概述

Api Policy Component是一个HTTP服务，为授权合作伙伴提供阅读器端点的门面。它主要功能包括：为B2B合作伙伴添加计算字段、屏蔽或隐藏非授权内容、根据账户配置重写查询。该组件通常与代理（Varnish）一起部署在其与实际阅读器端点之间，因此阅读器端点配置选项称为代理配置选项。

接口

该门面不定义自己的端点或接口契约，而是对Reader API的接口进行特定修改，且对其了解有限。

过滤器和策略

注意：一个策略可能被多个过滤器使用，过滤器也可能与多个策略协同工作。

Api过滤器

策略

头部处理

通常，头部从网关通过门面转发到Varnish层。Varnish应执行类似的头部转发，使得此处看到的头部也会被阅读器API看到。

以下头部是例外，它们都直接与底层TCP连接和数据编码相关。由于请求工作流的每个环节都是到新主机的独立连接，这些头部不会从一个TCP连接转发到下一个，但可能由本地库（如Jersey Client、Jetty）重新生成：

• "Host"：在请求中出现，指定要连接的主机。
• "Connection"：在响应中出现，向客户端指示TCP连接将保持活动或关闭。
• "Accept-Encoding"：在请求中出现，指示客户端是否支持GZip。
• "Content-Length"：在响应中出现，给出实体长度。我们会剥离此字段并让平台重新生成，因为它可能会变化。
• "Transfer-Encoding"：与Accept-Encoding相对应。
• Date：我们移除并重新生成此字段，以避免响应中出现两个Date值（Jetty曾添加第二个值）。由于我们修改响应，将日期增加几毫秒并不不准确。

本地运行与部署

本地编译运行

编译、运行测试并构建jar：

bash
mvn clean install

本地运行：

bash
java -jar api-policy-component-service/target/api-policy-component-service-1.0-SNAPSHOT.jar server api-policy-component-service/config-local.yml

Docker构建与运行

构建Docker镜像：

bash
docker build -t coco/api-policy-component:your-version .

运行Docker容器：

bash
docker run --rm -p 8080 -p 8081 --env "JAVA_OPTS=-Xms384m -Xmx384m -XX:+UseG1GC -server" --env "READ_ENDPOINT=localhost:8080:8080" --env "JERSEY_TIMEOUT_DURATION=***ms" coco/api-policy-component:your-version