Skip to content

Feature/4714 & 4715 Swagger annotations and Controller impls#886

Merged
sdavis-amido merged 2 commits intomasterfrom
feature/4714-4715-Swagger-Annotations-and-Controller-Impls
Jul 15, 2022
Merged

Feature/4714 & 4715 Swagger annotations and Controller impls#886
sdavis-amido merged 2 commits intomasterfrom
feature/4714-4715-Swagger-Annotations-and-Controller-Impls

Conversation

@sdavis-amido
Copy link
Contributor

📲 What

Refactored app code to: -

  1. Reduce Swagger API annotations in code base by using library annotations
  2. Remove controller Interface+Impl pattern to use a single RestController class to reduce boilerplate
  3. Use library DTO classes from Core API without repeating in this library

🤔 Why

To reduce boilerplate and duplicated code.

🛠 How

See ADR https://amidodevelopment.atlassian.net/wiki/spaces/TEC/pages/3776774161/ADR+Java+31+Refactor+Spring+Boot+apps+to+reduce+boilerplate+code+and+increase+separation+of+concerns#1.-REST-API-Implementation-Pattern

👀 Evidence

N/A

🕵️ How to test

mvn clean test for unit tests
mvn clean verify for other API tests

✅ Acceptance criteria Checklist

  • Code peer reviewed?
  • Documentation has been updated to reflect the changes?
  • Passing all automated tests, including a successful deployment?
  • Passing any exploratory testing?
  • Rebased/merged with latest changes from development and re-tested?
  • Meeting the Coding Standards?

@sdavis-amido
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@sdavis-amido sdavis-amido merged commit 4f24a76 into master Jul 15, 2022
@sdavis-amido sdavis-amido deleted the feature/4714-4715-Swagger-Annotations-and-Controller-Impls branch July 15, 2022 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant