Skip to content

Commit 7380bde

Browse files
wjwang00nobodyiam
wjwang00
and
nobodyiam
authored
feat: Provide a new open APl to return the organization list(#5349) (#5365)
* feat: Provide a new open APl to return the organization list(#5349) * update the CHANGES.md * Update apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/server/service/ServerOrganizationOpenApiService.java Co-authored-by: Jason Song <[email protected]> * Update apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/util/OpenApiBeanUtils.java Co-authored-by: Jason Song <[email protected]> * Update apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/v1/controller/OrganizationController.java Co-authored-by: Jason Song <[email protected]> * Update apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/util/OpenApiBeanUtils.java Co-authored-by: Jason Song <[email protected]> * update the CHANGES.md * Update CHANGES.md --------- Co-authored-by: Jason Song <[email protected]>
1 parent 9f91c02 commit 7380bde

File tree

5 files changed

+103
-10
lines changed

5 files changed

+103
-10
lines changed

‎CHANGES.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Apollo 2.5.0
88
* [Refactor: align permission validator api between openapi and portal](https://github.com/apolloconfig/apollo/pull/5337)
99
* [Feature: Provide a new configfiles API to return the raw content of configuration files directly](https://github.com/apolloconfig/apollo/pull/5336)
1010
* [Feature: Enhanced instance configuration auditing and caching](https://github.com/apolloconfig/apollo/pull/5361)
11+
* [Feature: Provide a new open API to return the organization list](https://github.com/apolloconfig/apollo/pull/5365)
1112

1213
------------------
1314
All issues and pull requests are [here](https://github.com/apolloconfig/apollo/milestone/16?closed=1)

‎apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/server/service/ServerOrganizationOpenApiService.java

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/*
2+
* Copyright 2024 Apollo Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*
16+
*/
17+
package com.ctrip.framework.apollo.openapi.server.service;
18+
19+
import com.ctrip.framework.apollo.openapi.api.OrganizationOpenApiService;
20+
import com.ctrip.framework.apollo.openapi.dto.OpenOrganizationDto;
21+
import com.ctrip.framework.apollo.openapi.util.OpenApiBeanUtils;
22+
import com.ctrip.framework.apollo.portal.component.config.PortalConfig;
23+
import org.springframework.stereotype.Service;
24+
import java.util.List;
25+
26+
@Service
27+
public class ServerOrganizationOpenApiService implements OrganizationOpenApiService {
28+
29+
private final PortalConfig portalConfig;
30+
31+
public ServerOrganizationOpenApiService(PortalConfig portalConfig) {
32+
this.portalConfig = portalConfig;
33+
}
34+
35+
@Override
36+
public List<OpenOrganizationDto> getOrganizations() {
37+
return OpenApiBeanUtils.transformFromOrganizations(portalConfig.organizations());
38+
}
39+
}

‎apollo-portal/src/main/java/com/ctrip/framework/apollo/openapi/util/OpenApiBeanUtils.java

+24-9
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,18 @@
2323
import java.util.Map;
2424
import java.util.Set;
2525
import java.util.stream.Collectors;
26+
27+
import com.ctrip.framework.apollo.openapi.dto.OpenAppDTO;
28+
import com.ctrip.framework.apollo.openapi.dto.OpenAppNamespaceDTO;
29+
import com.ctrip.framework.apollo.openapi.dto.OpenClusterDTO;
30+
import com.ctrip.framework.apollo.openapi.dto.OpenGrayReleaseRuleDTO;
31+
import com.ctrip.framework.apollo.openapi.dto.OpenGrayReleaseRuleItemDTO;
32+
import com.ctrip.framework.apollo.openapi.dto.OpenItemDTO;
33+
import com.ctrip.framework.apollo.openapi.dto.OpenNamespaceDTO;
34+
import com.ctrip.framework.apollo.openapi.dto.OpenNamespaceLockDTO;
35+
import com.ctrip.framework.apollo.openapi.dto.OpenReleaseDTO;
36+
import com.ctrip.framework.apollo.openapi.dto.OpenOrganizationDto;
37+
import com.ctrip.framework.apollo.portal.entity.vo.Organization;
2638
import org.springframework.util.CollectionUtils;
2739
import com.ctrip.framework.apollo.common.dto.ClusterDTO;
2840
import com.ctrip.framework.apollo.common.dto.GrayReleaseRuleDTO;
@@ -33,15 +45,6 @@
3345
import com.ctrip.framework.apollo.common.entity.App;
3446
import com.ctrip.framework.apollo.common.entity.AppNamespace;
3547
import com.ctrip.framework.apollo.common.utils.BeanUtils;
36-
import com.ctrip.framework.apollo.openapi.dto.OpenAppDTO;
37-
import com.ctrip.framework.apollo.openapi.dto.OpenAppNamespaceDTO;
38-
import com.ctrip.framework.apollo.openapi.dto.OpenClusterDTO;
39-
import com.ctrip.framework.apollo.openapi.dto.OpenGrayReleaseRuleDTO;
40-
import com.ctrip.framework.apollo.openapi.dto.OpenGrayReleaseRuleItemDTO;
41-
import com.ctrip.framework.apollo.openapi.dto.OpenItemDTO;
42-
import com.ctrip.framework.apollo.openapi.dto.OpenNamespaceDTO;
43-
import com.ctrip.framework.apollo.openapi.dto.OpenNamespaceLockDTO;
44-
import com.ctrip.framework.apollo.openapi.dto.OpenReleaseDTO;
4548
import com.ctrip.framework.apollo.portal.entity.bo.ItemBO;
4649
import com.ctrip.framework.apollo.portal.entity.bo.NamespaceBO;
4750
import com.google.common.base.Preconditions;
@@ -188,4 +191,16 @@ public static ClusterDTO transformToClusterDTO(OpenClusterDTO openClusterDTO) {
188191
Preconditions.checkArgument(openClusterDTO != null);
189192
return BeanUtils.transform(ClusterDTO.class, openClusterDTO);
190193
}
194+
195+
public static OpenOrganizationDto transformFromOrganization(final Organization organization){
196+
Preconditions.checkArgument(organization != null);
197+
return BeanUtils.transform(OpenOrganizationDto.class, organization);
198+
}
199+
200+
public static List<OpenOrganizationDto> transformFromOrganizations(final List<Organization> organizations){
201+
if (CollectionUtils.isEmpty(organizations)) {
202+
return Collections.emptyList();
203+
}
204+
return organizations.stream().map(OpenApiBeanUtils::transformFromOrganization).collect(Collectors.toList());
205+
}
191206
}

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

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* Copyright 2024 Apollo Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*
16+
*/
17+
package com.ctrip.framework.apollo.openapi.v1.controller;
18+
19+
import com.ctrip.framework.apollo.openapi.api.OrganizationOpenApiService;
20+
import org.springframework.web.bind.annotation.RequestMapping;
21+
import org.springframework.web.bind.annotation.RestController;
22+
import com.ctrip.framework.apollo.openapi.dto.OpenOrganizationDto;
23+
import java.util.List;
24+
25+
@RestController("openapiOrganizationController")
26+
@RequestMapping("/openapi/v1")
27+
public class OrganizationController {
28+
private final OrganizationOpenApiService organizationOpenApiService;
29+
30+
public OrganizationController(OrganizationOpenApiService organizationOpenApiService) {
31+
this.organizationOpenApiService = organizationOpenApiService;
32+
}
33+
34+
@RequestMapping("/organizations")
35+
public List<OpenOrganizationDto> getOrganization() {
36+
return organizationOpenApiService.getOrganizations();
37+
}
38+
}

‎pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
<revision>2.5.0-SNAPSHOT</revision>
6464
<java.version>1.8</java.version>
6565
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
66-
<apollo-java.version>2.4.0</apollo-java.version>
66+
<apollo-java.version>2.5.0-SNAPSHOT</apollo-java.version>
6767
<spring-boot.version>2.7.11</spring-boot.version>
6868
<spring-cloud.version>2021.0.5</spring-cloud.version>
6969
<!-- sort by alphabet -->

0 commit comments

Comments
 (0)