Backend applications

APIs should be written using Java, preferably with an industry standard framework such.

Use the current LTS version. Ensure that there is a process in place to upgrade it as new versions released.

Ensure dependabot or renovate has been configured so that dependencies are kept up to date.

Use gradle or maven to build the application. Ant is not recommended.

Use the Google Java Style Guide or a derivative.

Set up tooling to enforce coding standards such as checkstyle or spotless.

Use OWASP or Snyk for dependency scanning.

Use OpenAPI for API documentation.

Using JavaDoc is not necessary.

Documentation should not explain what the code is doing, but can be used to clarify why it is doing it.

This page was last reviewed on 25 January 2024. It needs to be reviewed again on 25 January 2025 by the page owner platops-build-notices .

This page was set to be reviewed before 25 January 2025 by the page owner platops-build-notices. This might mean the content is out of date.