refactor(REQ-3282): 调整统一路径规则 /api/org/** -> /api/**，移除/org这个部分

2024-12-18 20:30:15 +08:00 · 2024-12-18 20:30:15 +08:00 · 0fea429003
commit 0fea429003
parent de35a23047
14 changed files with 31 additions and 31 deletions
--- a/README.md
+++ b/README.md
@ -28,13 +28,13 @@
 - 接口出入参，必须使用可扩展的对象类型。不能直接是 String，Integer，或者List这些无法扩展的类型。
 - 为每个接口定义自己的出入参，不要复用出入参
 - 接口URL使用 【-】符号进行分割，比如: /orgmanax/node/create-team
- 接口定义规范： 使用```/api/org/${domain}/${affiliateDomain}/${action}``` 形式进行定义。如：
+- 接口定义规范： 使用```/api/${domain}/${affiliateDomain}/${action}``` 形式进行定义。如：
 ```
-/api/org/unit/create
-/api/org/unit/update
-/api/org/node-user/list
-/api/org/org-user/page
-/api/org/org-user/page
+/api/unit/create
+/api/unit/update
+/api/node-user/list
+/api/org-user/page
+/api/org-user/page
 ```
 * domain 为主要操作/查询的对象。包含以下值
 ```
--- a/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/cooperateship/feign/OrgCooperateShipApi.java
+++ b/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/cooperateship/feign/OrgCooperateShipApi.java
@ -27,7 +27,7 @@ public interface OrgCooperateShipApi {
     * @param req
     * @return
     */
-    @PostMapping("/api/org/cooperate-ship/list")
+    @PostMapping("/api/cooperate-ship/list")
    ApiResult<List<OrgCooperateShipDTO>> list(@RequestBody @Validated ListOrgCooperateShipReq req);

 }
--- a/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/node/feign/OrgNodeApi.java
+++ b/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/node/feign/OrgNodeApi.java
@ -28,7 +28,7 @@ public interface OrgNodeApi {
     * @param req
     * @return
     */
-    @PostMapping("/api/org/node/process")
+    @PostMapping("/api/node/process")
    ApiResult<JSONObject> process(@RequestBody @Validated ProcessNodeReq req);

    /**
@ -39,7 +39,7 @@ public interface OrgNodeApi {
     * @return
     * @see ListNodeReq#getPageSize()
     */
-    @PostMapping("/api/org/node/list")
+    @PostMapping("/api/node/list")
    ApiResult<PageResp<OrgNodeDTO>> list(@RequestBody @Validated ListNodeReq req);

 }
--- a/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/nodeuser/feign/OrgNodeUserApi.java
+++ b/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/nodeuser/feign/OrgNodeUserApi.java
@ -28,7 +28,7 @@ public interface OrgNodeUserApi {
     * @param req
     * @return
     */
-    @PostMapping("/api/org/node-user/process")
+    @PostMapping("/api/node-user/process")
    ApiResult<JSONObject> process(@RequestBody @Validated ProcessNodeUserReq req);

    /**
@ -39,7 +39,7 @@ public interface OrgNodeUserApi {
     * @return
     * @see ListNodeUserReq#getPageSize()
     */
-    @PostMapping("/api/org/node-user/list")
+    @PostMapping("/api/node-user/list")
    ApiResult<PageResp<OrgNodeUserDTO>> list(@RequestBody @Validated ListNodeUserReq req);

 }
--- a/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/orgjob/feign/OrgJobApi.java
+++ b/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/orgjob/feign/OrgJobApi.java
@ -19,15 +19,15 @@ import java.util.List;
        url = "${axzo.service.orgmanax:http://orgmanax:8080}")
 public interface OrgJobApi {

-    @PostMapping("/api/org/job/create")
+    @PostMapping("/api/job/create")
    ApiResult<OrgJobDTO> create(@RequestBody @Validated CreateOrgJobReq req);

-    @PostMapping("/api/org/job/update")
+    @PostMapping("/api/job/update")
    ApiResult<OrgJobDTO> update(@RequestBody @Validated UpdateOrgJobReq req);

-    @PostMapping("/api/org/job/delete")
+    @PostMapping("/api/job/delete")
    ApiResult<Void> delete(@RequestBody @Validated DeleteOrgJobReq req);

-    @PostMapping("/api/org/job/list")
+    @PostMapping("/api/job/list")
    ApiResult<PageResp<OrgJobDTO>> list(@RequestBody @Validated ListOrgJobReq req);
 }
--- a/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/orguser/feign/OrgUserApi.java
+++ b/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/orguser/feign/OrgUserApi.java
@ -33,7 +33,7 @@ public interface OrgUserApi {
     * @return
     * @see ListOrgUserReq#getPageSize()
     */
-    @PostMapping("/api/org/org-user/list")
+    @PostMapping("/api/org-user/list")
    ApiResult<PageResp<OrgUserDTO>> list(@RequestBody @Validated ListOrgUserReq req);

 }
--- a/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/unit/feign/OrgUnitApi.java
+++ b/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/unit/feign/OrgUnitApi.java
@ -29,7 +29,7 @@ public interface OrgUnitApi {
     * @param req
     * @return
     */
-    @PostMapping("/api/org/unit/create")
+    @PostMapping("/api/unit/create")
    ApiResult<CreateUnitResp> create(@RequestBody @Validated CreateUnitReq req);

    /**
@ -37,7 +37,7 @@ public interface OrgUnitApi {
     * @param req
     * @return
     */
-    @PostMapping("/api/org/unit/update")
+    @PostMapping("/api/unit/update")
    ApiResult<UpdateUnitResp> update(@RequestBody @Validated UpdateUnitReq req);

    /**
@ -48,7 +48,7 @@ public interface OrgUnitApi {
     * @return
     * @see ListUnitReq#getPageSize()
     */
-    @PostMapping("/api/org/unit/list")
+    @PostMapping("/api/unit/list")
    ApiResult<PageResp<OrgUnitDTO>> list(@RequestBody @Validated ListUnitReq req);

 }
--- a/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/unit/feign/OrgUnitContactApi.java
+++ b/orgmanax-api/src/main/java/cn/axzo/orgmanax/api/unit/feign/OrgUnitContactApi.java
@ -18,6 +18,6 @@ public interface OrgUnitContactApi {
    /**
     * 通过单位id获取单位联系人列表
     */
-    @PostMapping("/api/org/unit/contact/list")
+    @PostMapping("/api/unit/contact/list")
    ApiResult<List<OrgUnitContactResp>> list(List<Long> ouIds);
 }
--- a/orgmanax-api/src/test/resources/http/cooperateship/cooperate-ship.http
+++ b/orgmanax-api/src/test/resources/http/cooperateship/cooperate-ship.http
@ -1,5 +1,5 @@
 # 查询协同关系
-POST {{host}}/api/org/cooperate-ship/list
+POST {{host}}/api/cooperate-ship/list
 Content-Type: application/json
 Accept: application/json

--- a/orgmanax-api/src/test/resources/http/node/node.http
+++ b/orgmanax-api/src/test/resources/http/node/node.http
@ -1,5 +1,5 @@
 # 处理部门相关的逻辑
-POST {{host}}/api/org/node/process
+POST {{host}}/api/node/process
 Content-Type: application/json
 Accept: application/json

@ -18,7 +18,7 @@ Accept: application/json
 ###

 # 处理部门相关的逻辑
-POST {{host}}/api/org/node/list
+POST {{host}}/api/node/list
 Content-Type: application/json
 Accept: application/json

--- a/orgmanax-api/src/test/resources/http/nodeuser/node-user.http
+++ b/orgmanax-api/src/test/resources/http/nodeuser/node-user.http
@ -1,5 +1,5 @@
 # 分页列表接口
-POST {{host}}/api/org/node-user/list
+POST {{host}}/api/node-user/list
 Content-Type: application/json
 Accept: application/json

--- a/orgmanax-api/src/test/resources/http/orgjob/org-job.http
+++ b/orgmanax-api/src/test/resources/http/orgjob/org-job.http
@ -1,5 +1,5 @@
 #创建
-POST {{host}}/api/org/job/create
+POST {{host}}/api/job/create
 Content-Type: application/json
 Accept: application/json

@ -12,7 +12,7 @@ Accept: application/json
 ###

 #修改
-POST {{host}}/api/org/job/update
+POST {{host}}/api/job/update
 Content-Type: application/json
 Accept: application/json

@ -24,7 +24,7 @@ Accept: application/json
 ###

 #删除
-POST {{host}}/api/org/job/delete
+POST {{host}}/api/job/delete
 Content-Type: application/json
 Accept: application/json

@ -35,7 +35,7 @@ Accept: application/json
 ###

 # 查询
-POST {{host}}/api/org/job/list
+POST {{host}}/api/job/list
 Content-Type: application/json
 Accept: application/json

--- a/orgmanax-api/src/test/resources/http/orguser/org-user.http
+++ b/orgmanax-api/src/test/resources/http/orguser/org-user.http
@ -1,5 +1,5 @@
 # 查询
-POST {{host}}/api/org/org-user/list
+POST {{host}}/api/org-user/list
 Content-Type: application/json
 Accept: application/json

--- a/orgmanax-api/src/test/resources/http/unit/unit.http
+++ b/orgmanax-api/src/test/resources/http/unit/unit.http
@ -1,5 +1,5 @@
 # 创建单位
-POST {{host}}/api/org/unit/create
+POST {{host}}/api/unit/create
 Content-Type: application/json
 Accept: application/json

@ -11,7 +11,7 @@ Accept: application/json
 ###

 #分页列表接口
-POST {{host}}/api/org/unit/list
+POST {{host}}/api/unit/list
 Content-Type: application/json
 Accept: application/json