From 751d4b1744e9d4187bc8b88f15e2593a43da96a3 Mon Sep 17 00:00:00 2001 From: BuildTools Date: Sat, 5 Dec 2020 15:59:47 +0100 Subject: [PATCH] Readme update --- README.md | 47 +++++++++++-------- .../resources/application-prod.properties | 2 +- 2 files changed, 28 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 0be4755..4947eff 100755 --- a/README.md +++ b/README.md @@ -3,20 +3,7 @@ Zeby wystartowac aplikacje backendu najpierw nalezy postawic testowa baze danych na naszym komputerze za pomoca dockera. Jesli raz juz go odpalimy przy nastepnym razem bardzo mozliwe, ze wlaczy sie sam. AAby sprawdzic czy docker jesty wystartowany mozna uzyc `docker ps` ``` -docker-compose -f stack.yml up -``` - -Nastepnie w `restservice/src/main/resources/application.properties` nalezy podac ip naszego kontenera. - -``` -spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.MySQL5Dialect -spring.datasource.url=jdbc:mysql://localhost:3306/test -spring.datasource.username=root -spring.datasource.password=example -spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver -spring.jpa.hibernate.ddl-auto=create - -server.port=1285 +docker-compose -f stack.yml up -d ``` Następnym krokiem jest odpalenie poniższych komend w terminalu. @@ -26,7 +13,7 @@ cd restservice mvn spring-boot:run ``` -## Token +## Token obtaining Żeby tesotwać API wpełni potrzebny nam jest token który otrzymujemy na podstawie ticketa z systemu autoryzacyjnego **CAS**. Z tego powodu system autoryzacji działa inaczej niż w "książkowych" restowych aplikacjach i np Postman za nas jej nie dokona. Musimy mu podać już uzyskany token. Aby łatwo go uzyskać odpal skrypt @@ -36,13 +23,23 @@ python gettoken.py Na koniec w przęglądarce dostaniesz w odpowiedzi token. W samym pliku można zmienić porty aplikacji jeśli to potrzebne. -## Api docs +## Profiles -Żeby zobaczyć dokumentację api trzeba wejść w przeglądarce na `http://localhost:1285/swagger-ui.html` po odpaleniu aplikacji. +W aplikacji posiadamy dwa profile. `dev` i `prod`. **Dev** używamy do testowania aplikacji lokalnie. **Pord** służy do stworzenia builda na produkcję. +Profil wybieramy w pliku `restservice/src/main/resources/application.properties` wpisując odpowiednią nazwę -### Nazewnictwo odpowiedzi +``` +spring.profiles.active=prod +``` -Każdą odp zaczynamy od modelu, który opisuje np. `Courses` a kończymy na `Response`. Między tymi dwoma członami możemy dodawać modyfikatory opisujące dokładniej odpowiedź np. `Default`. W ten sposób możemy otrzymać nazwę `CoursesDefaultResponse.java` +Jeżeli chcemy zmienić jakieś opcję dla pordukcji to robimy to w tym sammym katalogi w pliku `application-prod.properties` i dla dev analogicznie w `application-dev.properties`. +W paczce dla proda w protpertiesach poufne dane odczytywane są ze zmiennych środowiskowych systemu na którym odpalana jest aplikacja. Ustawić trzeba następujące zmienne: + +- PLANNAPLAN_MYSQL_DB_HOST - host bazy danych np `localhost` +- PLANNAPLAN_MYSQL_DB_PORT - port na którym działa baza +- PLANNAPLAN_MYSQL_DB - nazwa bazy dancyh. W profilu **dev** jest to np test +- PLANNAPLAN_MYSQL_DB_USERNAME - nazwa użytkownika bazy +- PLANNAPLAN_MYSQL_DB_PASSWORD - hasło użytkownika bazy ## Packaging @@ -57,12 +54,22 @@ mvn clean package spring-boot:repackage Utworzony zostanie jar w `restservice/target/restservice-1.0-SNAPSHOT.jar`. Oczywiscie zeby jar zadzialal kontenery dockerowe musza byc odpalone (lub baza danych na serwerze jesli zmienialismy propertisy z localhost) -## Generowanie dokumentacji - javadoc +## Generowanie dokumentacji + +### Javadocs ```bash mvn javadoc:javadoc ``` +### Api docs + +Żeby zobaczyć dokumentację api trzeba wejść w przeglądarce na `http://localhost:1285/swagger-ui.html` po odpaleniu aplikacji. + +#### Nazewnictwo odpowiedzi + +Każdą odp zaczynamy od modelu, który opisuje np. `Courses` a kończymy na `Response`. Między tymi dwoma członami możemy dodawać modyfikatory opisujące dokładniej odpowiedź np. `Default`. W ten sposób możemy otrzymać nazwę `CoursesDefaultResponse.java` + ## Troubleshooting Spring chyba cacheuje jakies dane dotyczace polaczenia wiec jesli spring wywali Ci blad `Connection Refused`, a wiesz, ze ta baza stoi na podanym ip i porcie to sprobuj diff --git a/restservice/src/main/resources/application-prod.properties b/restservice/src/main/resources/application-prod.properties index b944224..b8e7a83 100755 --- a/restservice/src/main/resources/application-prod.properties +++ b/restservice/src/main/resources/application-prod.properties @@ -4,7 +4,7 @@ spring.datasource.username = ${PLANNAPLAN_MYSQL_DB_USERNAME} spring.datasource.password = ${PLANNAPLAN_MYSQL_DB_PASSWORD} spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver spring.jpa.open-in-view=true -spring.jpa.hibernate.ddl-auto=create-drop +spring.jpa.hibernate.ddl-auto=update spring.jackson.serialization.fail-on-empty-beans=false spring.main.allow-bean-definition-overriding=true spring.jackson.default-property-inclusion = NON_NULL