Skip to content

Commit ae0a153

Browse files
author
Hattinger04
committed
update readme
1 parent 0cd0043 commit ae0a153

File tree

1 file changed

+11
-19
lines changed

1 file changed

+11
-19
lines changed

README.MD

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,35 +56,27 @@ Should be changed when publishing it!
5656
All Services starts with /api!
5757

5858
1. /user services - available from DEV
59-
This are all Services which involves user data beginning with /user (links in brackets not made yet)
60-
- /getAllUsers (GET)
59+
This are all Services which involves user data beginning with /user (services in brackets are coming soon!)
60+
- /users (GET, POST, PUT, DELETE)
6161
- /logout (GET)
62-
- /getUser (POST - byUsername)
63-
- /createUser (PUT)
64-
- /updateUser (POST)
65-
- /addRole (PUT)
66-
- /removeRole (DELETE)
62+
- /roles (POST, DELETE)
6763
2. /hamster services - for all registered user available:
6864
All services which handles requests containing hamstercode beginning with /hamster
6965
- /defaultTerrain (POST)
7066
- /existingTerrain (POST)
7167
- /newTerrain (POST)
7268
3. Teacher services - available from TEACHER
7369
Services which are available for teachers to take control over their students begin with /teacher
74-
- /getAllStudents (GET)
75-
- /createClass (PUT)
76-
- /deleteClass (DELETE)
77-
- /addStudentClass (POST)
78-
- /removeStudentClass (DELETE)
79-
70+
- /students (GET)
71+
- /course (GET, POST, DELETE)
72+
- /course/students (GET, POST, DELETE)
73+
- /course/teachers (GET)
74+
- /exercises (GET, DELETE, POST, PUT)
75+
- (/rateExercises)
8076
3. /login service
8177
The login service; request sent as json => {"username": "username", "password": "password"}
8278
4. /register service
8379
The register service; request sent as json => {"username": "username", "password": "password", "email": "email"}
8480

85-
## Enable HTTPS for Spring (maybe better not to do)
86-
source: https://www.tutorialspoint.com/spring_boot/spring_boot_enabling_https.htm
87-
88-
1. keytool -genkey -alias tomcat -storetype PKCS12 -keyalg RSA -keysize 2048 -keystore keystore.p12 -validity 3650
89-
2. configure application.properties
90-
=> maybe better using the same ssl certificate as in nginx
81+
### Test
82+
To check if you installed everything correctly, I provided you with JUnit tests, which you can find in src/test/java/io/github/Hattinger04/

0 commit comments

Comments
 (0)