Skip to content
Snippets Groups Projects
Commit fd0a6fc2 authored by Hallvard Trætteberg's avatar Hallvard Trætteberg
Browse files

Fikset støtte for plantuml og opprettet (tomme) delkapitler.

parent 05c9149c
No related branches found
No related tags found
No related merge requests found
@startuml architecture
component core {
package todolist.core
package todolist.json
}
component jackson {
}
todolist.json ..> jackson
component fxutil {
}
component fxui {
package todolist.ui
}
todolist.ui ..> todolist.core
todolist.ui ..> todolist.json
component javafx {
component fxml {
}
}
fxui ..> javafx
fxui ..> fxml
fxui ..> fxutil
component restapi {
package todolist.restapi
}
todolist.restapi ..> todolist.core
component jaxrs {
}
restapi ..> jaxrs
component restserver {
package todolist.restserver
}
todolist.restserver ..> todolist.core
todolist.restserver ..> todolist.json
todolist.restserver ..> todolist.restapi
component jersey {
}
component grizzly2 {
}
restserver ..> jersey
restserver ..> grizzly2
component "springboot/restserver" as springboot.restserver {
package todolist.springboot.restserver
}
todolist.springboot.restserver ..> todolist.core
todolist.springboot.restserver ..> todolist.json
component "spring boot" as springboot {
}
springboot.restserver ..> springboot
@enduml
\ No newline at end of file
......@@ -3,13 +3,31 @@
== Forord
Denne modulen i todo-list-eksemplet inneholder dokumentasjon tenkt brukt som læringsmateriell,
ikke vanlig doumentasjon rettet mot utviklere av den typen en forventer i tilsvarende prosjekter.
ikke vanlig dokumentasjon rettet mot utviklere av den typen en forventer i tilsvarende prosjekter.
Dokumentasjonen er skrevet med https://asciidoctor.org/[Asciidoctor] og
bygget med image:maven-logo-black-on-white.png[Maven logo,60,link="https://maven.apache.org/"]
== Introduksjon
Todo-list er en applikasjon for håndtering av todo-lister.
Den er implementert som en kombinasjon av en JavaFX-app og et REST API som appen bruker for håndtering av data.
Med et REST API adskilt fra appen, så er det lett å utvide med andre klienter,
f.eks. en "native"-app for Android eller web-klient basert på React.
== Modularisering
Todolist er strukturert i et sett _moduler_. Domenelogikken ligger i core-modulen, appen i fxui (og fxutil),
mens REST API-et er fordelt over to moduler, restapi og restserver (og en alternativ implementasjon i springboot/restserver):
- <<core.adoc#, core>> - domenelogikken med alle klassene for å representeree todo-lister og -elementer, og støtte for serialisering og derialisering som JSON med Jackson-biblioteket
- <<fxui.adoc#, fxui (og fxutil)>> - app-brukergrensesnitt basert på JavaFX og FXML
- <<restapi.adoc#, restapi og restserver>> - REST API og server basert på JAX-RS-standarden og Jersey-implementasjonen
- <<springboot-restapi.adoc#, springboot/restserver>> - _alternativ_ REST API og server basert på spring boot-rammeverket
- <<integrationtests.adoc#, integrationtests>> - (integrasjons)test for app koblet til REST-serveren
Disse forklares i hver sine kapitler. Under viser et _pakkediagram_ strukturen av moduler og pakker og deres avhengigheter.
[plantuml]
....
component core {
......@@ -23,7 +41,6 @@ component jackson {
todolist.json ..> jackson
component fxutil {
package todolist.ui
}
component fxui {
......@@ -44,7 +61,7 @@ fxui ..> fxml
fxui ..> fxutil
component restapi {
package simpleex.restapi
package todolist.restapi
}
todolist.restapi ..> todolist.core
......
== Kjernelogikken
== Appen
== Integrasjonstest for app og REST API
== REST API
== REST API med Spring boot-rammeverket
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment