FINERACT-2021: refactor the note GET end-points to eliminate manual s…

…erialization with GSON.

- Implemented a new custom module for the note API.
- Used Spring Web-MVC annotations instead of JAX-RS.
- Dispensed the redundant query parameters like "fields, prettyPrint ..etc"

custom/gsoc/note/api/build.gradle

@@ -0,0 +1,26 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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
+ *
+ * http://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.
+ */
+
+description = 'GSoC Type-Safe API project: Note Api'
+
+group = 'org.apache.fineract.gsoc.note'
+
+archivesBaseName = 'fineract-custom-note-api'
+
+apply from: 'dependencies.gradle'

custom/gsoc/note/api/dependencies.gradle

@@ -0,0 +1,26 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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
+ *
+ * http://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.
+ */
+
+dependencies {
+ implementation(project(':fineract-core'))
+ implementation(project(':fineract-provider'))
+ implementation('org.springframework.boot:spring-boot-starter-web')
+ implementation('org.springframework.boot:spring-boot-starter')
+ implementation('io.swagger.core.v3:swagger-annotations-jakarta')
+}

custom/gsoc/note/api/src/main/java/org/apache/fineract/gsoc/note/api/NoteApiController.java

@@ -0,0 +1,116 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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
+ *
+ * http://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 org.apache.fineract.gsoc.note.api;
+
+import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
+import static org.springframework.http.MediaType.APPLICATION_PROBLEM_JSON_VALUE;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.ArraySchema;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import java.util.Collection;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.fineract.portfolio.note.api.NotesApiResourceSwagger;
+import org.apache.fineract.portfolio.note.data.NoteData;
+import org.apache.fineract.portfolio.note.domain.NoteType;
+import org.apache.fineract.portfolio.note.exception.NoteResourceNotSupportedException;
+import org.apache.fineract.portfolio.note.service.NoteReadPlatformService;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@Slf4j
+@RestController
+@RequestMapping(value = "/gsoc/{resourceType}/{resourceId}/notes", consumes = { APPLICATION_JSON_VALUE }, produces = {
+ APPLICATION_JSON_VALUE, APPLICATION_PROBLEM_JSON_VALUE })
+@Tag(name = "Notes", description = "Notes API allows to enter notes for supported resources.")
+@RequiredArgsConstructor
+public class NoteApiController {
+
+ private final NoteReadPlatformService noteReadService;
+
+ @GetMapping
+ @Operation(summary = "Retrieve a Resource's description", description = """
+ Retrieves a Resource's Notes
+
+ Note: Notes are returned in descending createOn order.
+
+ Example Requests:
+
+ clients/2/notes
+
+ groups/2/notes""")
+ @ApiResponses({
+ @ApiResponse(responseCode = "200", description = "OK", content = @Content(array = @ArraySchema(schema = @Schema(implementation = NotesApiResourceSwagger.GetResourceTypeResourceIdNotesResponse.class)))) })
+ public Collection<NoteData> retrieveNotesByResource(@PathVariable("resourceType") final String resourceType,
+ @PathVariable("resourceId") final Long resourceId) {
+
+ final NoteType noteType = NoteType.fromApiUrl(resourceType);
+
+ if (noteType == null) {
+ throw new NoteResourceNotSupportedException(resourceType);
+ }
+
+ // TODO: define this in a centralized security configuration
+ // this.context.authenticatedUser().validateHasReadPermission(getResourceDetails(noteType,
+ // resourceId).entityName());
+
+ final Integer noteTypeId = noteType.getValue();
+
+ return this.noteReadService.retrieveNotesByResource(resourceId, noteTypeId);
+ }
+
+ @GetMapping("/{noteId}")
+ @Operation(summary = "Retrieve a Resource Note", description = """
+ Retrieves a Resource Note
+
+ Example Requests:
+
+ clients/1/notes/76
+
+ groups/1/notes/20
+
+ clients/1/notes/76
+
+ groups/1/notes/20""")
+ @ApiResponses({
+ @ApiResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(implementation = NotesApiResourceSwagger.GetResourceTypeResourceIdNotesNoteIdResponse.class))) })
+ public NoteData retrieveNote(@PathVariable("resourceType") final String resourceType, @PathVariable("resourceId") final Long resourceId,
+ @PathVariable("noteId") final Long noteId) {
+
+ final NoteType noteType = NoteType.fromApiUrl(resourceType);
+
+ if (noteType == null) {
+ throw new NoteResourceNotSupportedException(resourceType);
+ }
+
+ // TODO: define this in a centralized security configuration
+ // this.context.authenticatedUser().validateHasReadPermission(getResourceDetails(noteType,
+ // resourceId).entityName());
+
+ return this.noteReadService.retrieveNote(noteId, resourceId, noteType.getValue());
+ }
+}