Expose @id fields for entity with spring-data-rest/springdoc-openapi-data-rest. Fixes #1146

Author: bnasslahsen

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/SpringDocDataRestConfiguration.java

@@ -259,12 +259,13 @@ DataRestTagsService dataRestTagsBuilder(OpenAPIService openAPIService) {
 		 * Spring doc data rest utils spring doc data rest utils.
 		 *
 		 * @param linkRelationProvider the link relation provider
+		 * @param repositoryRestConfiguration the repository rest configuration
 		 * @return the spring doc data rest utils
 		 */
 		@Bean
 		@ConditionalOnMissingBean
-		SpringDocDataRestUtils springDocDataRestUtils(LinkRelationProvider linkRelationProvider) {
-			return new SpringDocDataRestUtils(linkRelationProvider);
+		SpringDocDataRestUtils springDocDataRestUtils(LinkRelationProvider linkRelationProvider, RepositoryRestConfiguration repositoryRestConfiguration) {
+			return new SpringDocDataRestUtils(linkRelationProvider, repositoryRestConfiguration);
 		}
 	}
 

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/utils/EntityInfo.java

@@ -1,5 +1,6 @@
 package org.springdoc.data.rest.utils;
 
+import java.util.ArrayList;
 import java.util.List;
 
 /**
@@ -11,7 +12,7 @@ public class EntityInfo {
 	/**
 	 * The Ignored fields.
 	 */
-	private List<String> ignoredFields;
+	private List<String> ignoredFields = new ArrayList<>();
 
 	/**
 	 * The Associations fields.

springdoc-openapi-data-rest/src/main/java/org/springdoc/data/rest/utils/SpringDocDataRestUtils.java

@@ -30,6 +30,7 @@
 import org.springframework.data.mapping.PersistentProperty;
 import org.springframework.data.mapping.SimpleAssociationHandler;
 import org.springframework.data.mapping.context.PersistentEntities;
+import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
 import org.springframework.data.rest.core.mapping.ResourceMappings;
 import org.springframework.data.rest.core.mapping.ResourceMetadata;
 import org.springframework.data.rest.webmvc.RestMediaTypes;
@@ -67,13 +68,20 @@ public class SpringDocDataRestUtils {
 	 */
 	private HashMap<String, EntityInfo> entityInoMap = new HashMap();
 
+	/**
+	 * The Repository rest configuration.
+	 */
+	private RepositoryRestConfiguration repositoryRestConfiguration;
+
 	/**
 	 * Instantiates a new Spring doc data rest utils.
 	 *
 	 * @param linkRelationProvider the link relation provider
+	 * @param repositoryRestConfiguration the repository rest configuration
 	 */
-	public SpringDocDataRestUtils(LinkRelationProvider linkRelationProvider) {
+	public SpringDocDataRestUtils(LinkRelationProvider linkRelationProvider, RepositoryRestConfiguration repositoryRestConfiguration) {
 		this.linkRelationProvider = linkRelationProvider;
+		this.repositoryRestConfiguration = repositoryRestConfiguration;
 	}
 
 	/**
@@ -93,7 +101,8 @@ public void customise(OpenAPI openAPI, ResourceMappings mappings, PersistentEnti
 					EntityInfo entityInfo = new EntityInfo();
 					entityInfo.setDomainType(domainType);
 					List<String> ignoredFields = getIgnoredFields(resourceMetadata, entity);
-					entityInfo.setIgnoredFields(ignoredFields);
+					if (!repositoryRestConfiguration.isIdExposedFor(entity.getType()))
+						entityInfo.setIgnoredFields(ignoredFields);
 					List<String> associationsFields = getAssociationsFields(resourceMetadata, entity);
 					entityInfo.setAssociationsFields(associationsFields);
 					entityInoMap.put(domainType.getSimpleName(), entityInfo);

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app26/Person.java

@@ -0,0 +1,64 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
+ *  *  *
+ *  *
+ *
+ *
+ */
+
+package test.org.springdoc.api.app26;
+
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+
+@Entity
+public class Person {
+
+	@Id
+	@GeneratedValue(strategy = GenerationType.AUTO)
+	private long id;
+
+	private String firstName;
+	private String lastName;
+
+	public long getId() {
+		return id;
+	}
+
+	public void setId(long id) {
+		this.id = id;
+	}
+
+	public String getFirstName() {
+		return firstName;
+	}
+
+	public void setFirstName(String firstName) {
+		this.firstName = firstName;
+	}
+
+	public String getLastName() {
+		return lastName;
+	}
+
+	public void setLastName(String lastName) {
+		this.lastName = lastName;
+	}
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app26/PersonRepository.java

@@ -0,0 +1,37 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
+ *  *  *
+ *  *
+ *
+ *
+ */
+
+package test.org.springdoc.api.app26;
+
+import java.util.List;
+
+import org.springframework.data.repository.PagingAndSortingRepository;
+import org.springframework.data.repository.query.Param;
+import org.springframework.data.rest.core.annotation.RepositoryRestResource;
+
+@RepositoryRestResource(collectionResourceRel = "people", path = "peopleme")
+public interface PersonRepository extends PagingAndSortingRepository<Person, Long> {
+
+	List<Person> findByLastName(@Param("name") String name);
+
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app26/SpringDocApp26Test.java

@@ -0,0 +1,36 @@
+/*
+ *
+ *  *
+ *  *  *
+ *  *  *  * Copyright 2019-2020 the original author or authors.
+ *  *  *  *
+ *  *  *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  *  *  * you may not use this file except in compliance with the License.
+ *  *  *  * You may obtain a copy of the License at
+ *  *  *  *
+ *  *  *  *      https://www.apache.org/licenses/LICENSE-2.0
+ *  *  *  *
+ *  *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  *  * See the License for the specific language governing permissions and
+ *  *  *  * limitations under the License.
+ *  *  *
+ *  *
+ *
+ *
+ */
+
+package test.org.springdoc.api.app26;
+
+import test.org.springdoc.api.AbstractSpringDocTest;
+
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+public class SpringDocApp26Test extends AbstractSpringDocTest {
+
+	@SpringBootApplication
+	static class SpringDocTestApp {
+	}
+
+}

springdoc-openapi-data-rest/src/test/java/test/org/springdoc/api/app26/SpringRestConfiguration.java

@@ -0,0 +1,13 @@
+package test.org.springdoc.api.app26;
+
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.rest.core.config.RepositoryRestConfiguration;
+import org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer;
+
+@Configuration
+public class SpringRestConfiguration implements RepositoryRestConfigurer {
+	@Override
+	public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) {
+		config.exposeIdsFor(Person.class);
+	}
+}