Edge API Core (Common Infrastructure) (UXPROD-994)

[UXPROD-2973] Create Spring-way equivalent of edge-common Created: 12/Mar/21  Updated: 19/Aug/21  Resolved: 19/Aug/21

Status: Closed
Project: UX Product
Components: None
Affects versions: None
Fix versions: R2 2021
Parent: Edge API Core (Common Infrastructure)

Type: New Feature Priority: P3
Reporter: Craig McNally Assignee: Mikhail Fokanov
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
blocks EDGDEMATIC-15 edge-dematic migration to use edge-co... Draft
Relates
relates to EDGCMNSPR-1 Create Project Skeleton Closed
relates to EDGCMNSPR-2 Port edge-common to spring-way Closed
relates to EDGAPIUTL-1 Initial development of edge-api-utils Closed
Epic Link: Edge API Core (Common Infrastructure)
Front-End Confidence factor: High
Back End Estimate: Large < 10 days
Development Team: Other dev
PO Rank: 0
Rank: U of AL (MVP Oct 2020): R3

 Description   

Current situation or problem:
Folio has approved and adopted the spring way for module development, and new modules are now being developed with this technology stack. However, there's no spring-way equivalent of edge-common for use in development of edge APIs. Having such an equivalent will allow development teams currently using the spring-way for module development to use a similar technology stack and programming patterns when developing edge APIs.

This purpose of this edge-common-spring framework is the same as the original edge-common; provide the functionality which is common to all HTTP-based edge APIs. The only real difference is the underlying technology used (Spring instead of Vertx).

In scope

  • A framework for developing edge APIs based on the spring-way tech stack.
  • Feature parity with edge-common.
  • To ease the impact on system operators, care should be taken to limit the number of runtime differences (e.g. configuration property names, API key structure, secure store integrations, etc.

Out of scope
Functionality above/beyond that which is currently provided by edge-common

Use case(s)
Two edge APIs have already begun down the path of implementing edge APIs using the spring-way tech stack: edge-dematic and edge-srs-search. There will undoubtedly be others in the future.

Proposed solution/stories

  • Create the edge-common-spring skeleton - Project setup (JIRA, github, boilerplate files, project structure, etc.)
  • Implement edge-common-spring - Can probably use edge-dematic as a point of reference.
  • Documentation - Clearly document how to use the framework. If there are differences that are important to SysOps, ensure they're clearly outlined.
  • [Optional] Create an edge-api-utils- Project setup and impl. (JIRA, github, boilerplate files, project structure, etc.). This will be comprised of classes/utilities shared by both edge-common and edge-common-spring, e.g. SecureStore(s), ApiKeyHelper, TokenCache, etc.

Links to additional info

Questions



 Comments   
Comment by Khalilah Gambrell [ 20/Jul/21 ]

Mikhail Fokanov, should this feature be set to Closed - Done? And will this feature be included in the Juniper release?

Generated at Fri Feb 09 00:28:20 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.