openapi请求如果key是a.bS/TT/AT，则报404错误 #4447

PeterHang · 2022-07-06T04:04:13Z

openapi的Java client，1.7.0，如果key是a.bS/TT/AT，则请求就会报404错误。上次修完后，[]是可以了，但是key为a.bS/TT/AT还是不行，只不过这次报404了

CalebZYC · 2022-07-06T15:24:46Z

tomcat路径中允许未编码的字符和查询字符串中允许的未编码字符，/字符不在范围内

" < > [ \ ] ^ ` { | }

tomcat attribute

PeterHang · 2022-07-07T02:21:52Z

那这就比较尴尬了，在网页上操作是允许放 / 字符的，在openapi就不行了，那应该怎么办？
总不能因为网页上key是放在body里面，openapi的key是在url里面，然后有些key的字符在open api就不支持，对吧？

PeterHang · 2022-07-08T03:12:52Z

tomcat路径中允许未编码的字符和查询字符串中允许的未编码字符，/字符不在范围内
" < > [ \ ] ^ ` { | }
tomcat attribute

那这就比较尴尬了，在网页上操作是允许放 / 字符的，在openapi就不行了，那应该怎么办？
总不能因为网页上key是放在body里面，openapi的key是在url里面，然后有些key的字符在open api就不支持，对吧？

qmwu2000 · 2022-07-11T02:04:14Z

tomcat具体支持哪些字符不重要，重要的是所有客户端必须严格按照HTTP协议规定的格式发送请求，该怎么编码就怎么编码，不能与具体哪一个web container绑定。

…

On Jul 8, 2022, at 11:13, PeterHang ***@***.***> wrote: tomcat路径中允许未编码的字符和查询字符串中允许的未编码字符，/字符不在范围内 " < > [ \ ] ^ ` { | } <https://user-images.githubusercontent.com/42887532/177584445-a2450cce-999c-44bd-8ce1-a249335a73c7.png> tomcat attribute <https://tomcat.apache.org/tomcat-8.5-doc/config/http.html> 那这就比较尴尬了，在网页上操作是允许放 / 字符的，在openapi就不行了，那应该怎么办？总不能因为网页上key是放在body里面，openapi的key是在url里面，然后有些key的字符在open api就不支持，对吧？ — Reply to this email directly, view it on GitHub <#4447 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AASQE76E63SX7N76INUPDILVS6MEPANCNFSM52YHMFWA>. You are receiving this because you are subscribed to this thread.

PeterHang · 2022-07-11T02:37:30Z

tomcat具体支持哪些字符不重要，重要的是所有客户端必须严格按照HTTP协议规定的格式发送请求，该怎么编码就怎么编码，不能与具体哪一个web container绑定。

那现在可以在网页上保存key里面含有“/”字符，用Apollo open api的Java client 应该请求？

PeterHang · 2022-07-11T02:39:52Z

tomcat具体支持哪些字符不重要，重要的是所有客户端必须严格按照HTTP协议规定的格式发送请求，该怎么编码就怎么编码，不能与具体哪一个web container绑定。
…
On Jul 8, 2022, at 11:13, PeterHang @.***> wrote: tomcat路径中允许未编码的字符和查询字符串中允许的未编码字符，/字符不在范围内 " < > [ \ ] ^ ` { | } https://user-images.githubusercontent.com/42887532/177584445-a2450cce-999c-44bd-8ce1-a249335a73c7.png tomcat attribute https://tomcat.apache.org/tomcat-8.5-doc/config/http.html 那这就比较尴尬了，在网页上操作是允许放 / 字符的，在openapi就不行了，那应该怎么办？总不能因为网页上key是放在body里面，openapi的key是在url里面，然后有些key的字符在open api就不支持，对吧？ — Reply to this email directly, view it on GitHub <#4447 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AASQE76E63SX7N76INUPDILVS6MEPANCNFSM52YHMFWA. You are receiving this because you are subscribed to this thread.

那现在可以在网页上保存key里面含有“/”字符，用Apollo open api的Java client 应该请求？

nobodyiam · 2022-07-12T01:15:22Z

那现在可以在网页上保存key里面含有“/”字符，用Apollo open api的Java client 应该请求？

造成这个差异的原因是通过页面修改/删除配置的接口没有把 key 放在 url path 上，而 open api 的实现是把 key 放在 url path 上的。
updateItem 可以比较简单的适配一下，比如新开一个不带 key 的接口。
deleteItem 的适配就要麻烦一点了，因为 openapi 现在的 dto 没有把 item id 返回给调用端，这个得看下实现方案。

apollo/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/controller/ItemController.java

Lines 109 to 113 in 3440475

    
           @PreAuthorize(value = "@permissionValidator.hasModifyNamespacePermission(#appId, #namespaceName, #env)") 
        
           @PutMapping("/apps/{appId}/envs/{env}/clusters/{clusterName}/namespaces/{namespaceName}/item") 
        
           public void updateItem(@PathVariable String appId, @PathVariable String env, 
        
                                  @PathVariable String clusterName, @PathVariable String namespaceName, 
        
                                  @RequestBody ItemDTO item) {

apollo/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/controller/ItemController.java

Lines 123 to 127 in 3440475

    
           @PreAuthorize(value = "@permissionValidator.hasModifyNamespacePermission(#appId, #namespaceName, #env) ") 
        
           @DeleteMapping("/apps/{appId}/envs/{env}/clusters/{clusterName}/namespaces/{namespaceName}/items/{itemId}") 
        
           public void deleteItem(@PathVariable String appId, @PathVariable String env, 
        
                                  @PathVariable String clusterName, @PathVariable String namespaceName, 
        
                                  @PathVariable long itemId) {

apollo/apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/ItemController.java

Lines 84 to 89 in 3440475

    
           @PreAuthorize(value = "@consumerPermissionValidator.hasModifyNamespacePermission(#request, #appId, #namespaceName, #env)") 
        
           @PutMapping(value = "/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/items/{key:.+}") 
        
           public void updateItem(@PathVariable String appId, @PathVariable String env, 
        
                                  @PathVariable String clusterName, @PathVariable String namespaceName, 
        
                                  @PathVariable String key, @RequestBody OpenItemDTO item, 
        
                                  @RequestParam(defaultValue = "false") boolean createIfNotExists, HttpServletRequest request) {

apollo/apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/ItemController.java

Lines 115 to 120 in 3440475

    
           @PreAuthorize(value = "@consumerPermissionValidator.hasModifyNamespacePermission(#request, #appId, #namespaceName, #env)") 
        
           @DeleteMapping(value = "/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/items/{key:.+}") 
        
           public void deleteItem(@PathVariable String appId, @PathVariable String env, 
        
                                  @PathVariable String clusterName, @PathVariable String namespaceName, 
        
                                  @PathVariable String key, @RequestParam String operator, 
        
                                  HttpServletRequest request) {

PeterHang · 2022-08-03T06:48:47Z

那现在可以在网页上保存key里面含有“/”字符，用Apollo open api的Java client 应该请求？

造成这个差异的原因是通过页面修改/删除配置的接口没有把 key 放在 url path 上，而 open api 的实现是把 key 放在 url path 上的。 updateItem 可以比较简单的适配一下，比如新开一个不带 key 的接口。 deleteItem 的适配就要麻烦一点了，因为 openapi 现在的 dto 没有把 item id 返回给调用端，这个得看下实现方案。

apollo/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/controller/ItemController.java

Lines 109 to 113 in 3440475

@PreAuthorize(value = "@permissionValidator.hasModifyNamespacePermission(#appId, #namespaceName, #env)")

@PutMapping("/apps/{appId}/envs/{env}/clusters/{clusterName}/namespaces/{namespaceName}/item")

public void updateItem(@PathVariable String appId, @PathVariable String env,

@PathVariable String clusterName, @PathVariable String namespaceName,

@RequestBody ItemDTO item) {

apollo/apollo-portal/src/main/java/com/ctrip/framework/apollo/portal/controller/ItemController.java

Lines 123 to 127 in 3440475

@PreAuthorize(value = "@permissionValidator.hasModifyNamespacePermission(#appId, #namespaceName, #env) ")

@DeleteMapping("/apps/{appId}/envs/{env}/clusters/{clusterName}/namespaces/{namespaceName}/items/{itemId}")

public void deleteItem(@PathVariable String appId, @PathVariable String env,

@PathVariable String clusterName, @PathVariable String namespaceName,

@PathVariable long itemId) {

apollo/apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/ItemController.java

Lines 84 to 89 in 3440475

@PreAuthorize(value = "@consumerPermissionValidator.hasModifyNamespacePermission(#request, #appId, #namespaceName, #env)")

@PutMapping(value = "/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/items/{key:.+}")

public void updateItem(@PathVariable String appId, @PathVariable String env,

@PathVariable String clusterName, @PathVariable String namespaceName,

@PathVariable String key, @RequestBody OpenItemDTO item,

@RequestParam(defaultValue = "false") boolean createIfNotExists, HttpServletRequest request) {

apollo/apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/ItemController.java

Lines 115 to 120 in 3440475

@PreAuthorize(value = "@consumerPermissionValidator.hasModifyNamespacePermission(#request, #appId, #namespaceName, #env)")

@DeleteMapping(value = "/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/items/{key:.+}")

public void deleteItem(@PathVariable String appId, @PathVariable String env,

@PathVariable String clusterName, @PathVariable String namespaceName,

@PathVariable String key, @RequestParam String operator,

HttpServletRequest request) {

本地试了下，如果改的话，admin service也得改。查询item的话，还是将key放在URL上去查询的。

nobodyiam · 2022-08-06T12:13:47Z

@PeterHang 是的，更新还好搞一些，PUT 操作可以把 item key 放在 body 里面，查询和删除这两个操作比较麻烦，GET 和 DELETE 只能放在 url path 上

AbnerHuang2 · 2022-08-17T03:14:10Z

是的，更新还好搞一些，PUT 操作可以把 item key 放在 body 里面，查询和删除这两个操作比较麻烦，GET 和 DELETE 只能放在 url path 上

what if we just encode/decode the item key ? we can provide new interface on get/update/delete , and we encode the item key in client and decode key in admin service. in this way , the old client can also work normally. what do you think ? @nobodyiam

snowy861227 · 2022-08-18T09:05:39Z

有什么进展吗？考虑更新支持key中带/的openapi更新吗？

nobodyiam · 2022-08-19T00:59:27Z

what if we just encode/decode the item key ? we can provide new interface on get/update/delete , and we encode the item key in client and decode key in admin service. in this way , the old client can also work normally. what do you think ?

@AbnerHuang2 I'm interested in this proposal, would you please give an example to show your idea?

AbnerHuang2 · 2022-08-23T00:59:10Z

take getItem as an example, when we called getItem with openapi client, we can encode the key like the follow way,

    String encode = new String(Base64.getEncoder().encode(key.getBytes(StandardCharsets.UTF_8)));
    OpenApiPathBuilder pathBuilder = OpenApiPathBuilder.newBuilder()
        .envsPathVal(env)
        .appsPathVal(appId)
        .clustersPathVal(clusterName)
        .namespacesPathVal(namespaceName)
        .itemsPathVal(encode);

and this will execute in portal/ItemOpenController, and in this controller passthrough the key to adminservice/ItemController, and in adminservice/ItemController we decode the key like follow way,

key = new String(Base64.getDecoder().decode(key.getBytes(StandardCharsets.UTF_8)));
Item item = itemService.findOne(appId, clusterName, namespaceName, key);

then we can get the correct result.

ps, the encode/decode algorithm can be replace with other simple algorithm if their is more effective encode/decode algorithm.
@nobodyiam

AbnerHuang2 · 2022-08-23T01:10:17Z

Test example:

Test Result:

nobodyiam · 2022-08-26T00:29:59Z

@AbnerHuang2

This is an interesting proposal! In this way, we could add a new set of open apis that accept encoded keys.
I think we may still call the old set of apis if the key has no special character to make the apollo-openapi-client compatible with the old versions of apollo-portal.

AbnerHuang2 · 2022-08-26T06:41:56Z

wow, this way is more practicable, in the normal sutuation, it works like the old workflow, and we just use little cost to deal with unexpectable key, I'll try this. but I need to finished #4519 first.

chenxing1020 · 2022-08-29T00:55:55Z

In my situation, I wrote a apollo portal http client, that also works.

snowy861227 · 2022-09-16T07:30:32Z

Does the newclient can open to work now？Could you share me the note ？thanks

…

---原始邮件--- 发件人: "Jason ***@***.***> 发送时间: 2022年8月19日(周五) 上午8:59 收件人: ***@***.***>; 抄送: ***@***.******@***.***>; 主题: Re: [apolloconfig/apollo] openapi请求如果key是a.bS/TT/AT，则报404错误 (Issue #4447) what if we just encode/decode the item key ? we can provide new interface on get/update/delete , and we encode the item key in client and decode key in admin service. in this way , the old client can also work normally. what do you think ? @AbnerHuang2 I'm interested in this proposal, would you please give an example to show your idea? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.Message ID: ***@***.***>

nobodyiam · 2022-09-17T11:59:25Z

@snowy861227 This fix was merged to the master branch and not yet released.

PeterHang closed this as completed Jul 11, 2022

PeterHang reopened this Jul 11, 2022

nobodyiam added the help wanted label Aug 4, 2022

AbnerHuang2 mentioned this issue Sep 3, 2022

fix openapi item with url illegalKey 400 error #4549

Merged

5 tasks

nobodyiam closed this as completed in #4549 Sep 11, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

openapi请求如果key是a.bS/TT/AT，则报404错误 #4447

openapi请求如果key是a.bS/TT/AT，则报404错误 #4447

PeterHang commented Jul 6, 2022 •

edited

Loading

CalebZYC commented Jul 6, 2022

PeterHang commented Jul 7, 2022

PeterHang commented Jul 8, 2022

qmwu2000 commented Jul 11, 2022 via email

PeterHang commented Jul 11, 2022 •

edited

Loading

PeterHang commented Jul 11, 2022

nobodyiam commented Jul 12, 2022

PeterHang commented Aug 3, 2022

nobodyiam commented Aug 6, 2022

AbnerHuang2 commented Aug 17, 2022

snowy861227 commented Aug 18, 2022

nobodyiam commented Aug 19, 2022

AbnerHuang2 commented Aug 23, 2022

AbnerHuang2 commented Aug 23, 2022

nobodyiam commented Aug 26, 2022

AbnerHuang2 commented Aug 26, 2022

chenxing1020 commented Aug 29, 2022

snowy861227 commented Sep 16, 2022 via email

nobodyiam commented Sep 17, 2022

openapi请求如果key是a.bS/TT/AT，则报404错误 #4447

openapi请求如果key是a.bS/TT/AT，则报404错误 #4447

Comments

PeterHang commented Jul 6, 2022 • edited Loading

CalebZYC commented Jul 6, 2022

PeterHang commented Jul 7, 2022

PeterHang commented Jul 8, 2022

qmwu2000 commented Jul 11, 2022 via email

PeterHang commented Jul 11, 2022 • edited Loading

PeterHang commented Jul 11, 2022

nobodyiam commented Jul 12, 2022

PeterHang commented Aug 3, 2022

nobodyiam commented Aug 6, 2022

AbnerHuang2 commented Aug 17, 2022

snowy861227 commented Aug 18, 2022

nobodyiam commented Aug 19, 2022

AbnerHuang2 commented Aug 23, 2022

AbnerHuang2 commented Aug 23, 2022

nobodyiam commented Aug 26, 2022

AbnerHuang2 commented Aug 26, 2022

chenxing1020 commented Aug 29, 2022

snowy861227 commented Sep 16, 2022 via email

nobodyiam commented Sep 17, 2022

PeterHang commented Jul 6, 2022 •

edited

Loading

PeterHang commented Jul 11, 2022 •

edited

Loading