diff --git a/build.gradle b/build.gradle index 5d3de9774dc6156d163546deb03948cc9bc9617c..8221f3bb74a06ffdcbabb9fafa09f64f9afe17c5 100644 --- a/build.gradle +++ b/build.gradle @@ -24,6 +24,11 @@ dependencies { testImplementation 'org.springframework.boot:spring-boot-starter-test' } +javadoc { + title = "SIL ERP BACK 0.0.1 API Specification" + options.overview = "src/main/java/overview.html" +} + test { useJUnitPlatform() } diff --git a/gradle.properties b/gradle.properties index 263735322c65c0369676f8f1e1a9b68a16a503e3..ae2f23dd23c9aa155e3973bc64facc4e37970a6c 100644 --- a/gradle.properties +++ b/gradle.properties @@ -2,3 +2,5 @@ version=1.0 license=https://cecill.info/licences/Licence_CeCILL-B_V1-fr.html netbeans.license=cecill-b + +org.gradle.warning.mode=all \ No newline at end of file diff --git a/settings.gradle b/settings.gradle index d90f81de356338909caaa6d7fc3b78f964154f4f..935d49976ba7cd9cdabebf8dc54022486018fcef 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1 +1 @@ -rootProject.name = 'erp.back' +rootProject.name = 'SIL ERP BACK' diff --git a/src/main/java/fr/unistra/sil/erp/back/WebMvcConfig.java b/src/main/java/fr/unistra/sil/erp/back/WebMvcConfig.java index 8680c63a04bccf2160ecb7575996504c453c898c..2b7e9cc15681ffbba21a31629c1a3430a5317142 100644 --- a/src/main/java/fr/unistra/sil/erp/back/WebMvcConfig.java +++ b/src/main/java/fr/unistra/sil/erp/back/WebMvcConfig.java @@ -89,7 +89,7 @@ public class WebMvcConfig implements WebMvcConfigurer { * Currently, interceptors are only used for authentication in this * application. * - * @param registry + * @param registry the Interceptor Registry to use for additions. */ @Override public void addInterceptors(InterceptorRegistry registry) { diff --git a/src/main/java/fr/unistra/sil/erp/back/controller/api/package-info.java b/src/main/java/fr/unistra/sil/erp/back/controller/api/package-info.java new file mode 100644 index 0000000000000000000000000000000000000000..dba057b6adcf104519dac90084a3b20b5310cc04 --- /dev/null +++ b/src/main/java/fr/unistra/sil/erp/back/controller/api/package-info.java @@ -0,0 +1,4 @@ +/** + * API implementations of the HTTP controllers. + */ +package fr.unistra.sil.erp.back.controller.api; \ No newline at end of file diff --git a/src/main/java/fr/unistra/sil/erp/back/controller/package-info.java b/src/main/java/fr/unistra/sil/erp/back/controller/package-info.java new file mode 100644 index 0000000000000000000000000000000000000000..9b80cb2dfe9937b2bce6e263ccdd397c68b83a2a --- /dev/null +++ b/src/main/java/fr/unistra/sil/erp/back/controller/package-info.java @@ -0,0 +1,7 @@ +/** + * Controller interfaces to handle HTTP requests. + * + * Controllers are responsible for processing requests once they have + * been approved by interceptors. + */ +package fr.unistra.sil.erp.back.controller; \ No newline at end of file diff --git a/src/main/java/fr/unistra/sil/erp/back/db/package-info.java b/src/main/java/fr/unistra/sil/erp/back/db/package-info.java new file mode 100644 index 0000000000000000000000000000000000000000..a333ba19082c1a093a4350b523a7dd43b5710621 --- /dev/null +++ b/src/main/java/fr/unistra/sil/erp/back/db/package-info.java @@ -0,0 +1,4 @@ +/** + * Database interfaces and implementations. + */ +package fr.unistra.sil.erp.back.db; \ No newline at end of file diff --git a/src/main/java/fr/unistra/sil/erp/back/interceptor/api/package-info.java b/src/main/java/fr/unistra/sil/erp/back/interceptor/api/package-info.java new file mode 100644 index 0000000000000000000000000000000000000000..66f0804e3c1acf77ec28f7ca448b65e3c12d6861 --- /dev/null +++ b/src/main/java/fr/unistra/sil/erp/back/interceptor/api/package-info.java @@ -0,0 +1,8 @@ +/** + * API Interceptors for the HTTP requests. + * + * Interceptors are run between the user's request and the associated + * controller. They allow for pre-processing and post-processing of HTTP + * requests beyond their respective controllers. + */ +package fr.unistra.sil.erp.back.interceptor.api; \ No newline at end of file diff --git a/src/main/java/fr/unistra/sil/erp/back/model/package-info.java b/src/main/java/fr/unistra/sil/erp/back/model/package-info.java new file mode 100644 index 0000000000000000000000000000000000000000..b081226a9fa861cff655c8966ef34245e723cc09 --- /dev/null +++ b/src/main/java/fr/unistra/sil/erp/back/model/package-info.java @@ -0,0 +1,7 @@ +/** + * Model classes for the module's objects. + * + * These are the main classes that represent the data manipulated by + * the application, such as transactions, items, registry entries, etc. + */ +package fr.unistra.sil.erp.back.model; \ No newline at end of file diff --git a/src/main/java/fr/unistra/sil/erp/back/package-info.java b/src/main/java/fr/unistra/sil/erp/back/package-info.java new file mode 100644 index 0000000000000000000000000000000000000000..0cf38f54e5aeced7751fa16b68512a3ee3b397be --- /dev/null +++ b/src/main/java/fr/unistra/sil/erp/back/package-info.java @@ -0,0 +1,18 @@ +/** + * BACK module for the ERP solution. + * + * The objective of this program is to provide financial documentation + * on request as well as provide item information to the other modules. + * + * The application is split in two components: + * <ul> + * <li>RESTful API for interoperability with the other components, + * <li>Web interface for regular Human-Machine Interface (HMI) interactions. + * </ul> + * + * Notice: Only the API is currently implemented (partially) for now. + * + * @version 0.0.1 + * @author BEAUVAIS ANTOINE + */ +package fr.unistra.sil.erp.back; \ No newline at end of file diff --git a/src/main/java/overview.html b/src/main/java/overview.html new file mode 100644 index 0000000000000000000000000000000000000000..276c8557170ec5367a03a1187c2d9d999648cf23 --- /dev/null +++ b/src/main/java/overview.html @@ -0,0 +1,19 @@ +<!DOCTYPE html> +<!-- +CONTRAT DE LICENCE DE LOGICIEL LIBRE CeCILL-B +https://cecill.info/licences/Licence_CeCILL-B_V1-fr.html +--> +<body> + <p>This is the BACK module for the 2021-2022 M2 SIL ERP project.</p> + + <p>This module is responsible for providing item information to the + other components as well as provide financial documentation.</p> + + <p>It is divided in two components:</p> + <ul> + <li>a RESTful API for interoperability between the components, and</li> + <li>a Web interface for managing the software and data.</li> + </ul> + + <p>Currently, only the RESTful API is partially implemented.</p> +</body> \ No newline at end of file