Skip to content

bintangginanjar/Running-Club-RestfulAPI

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
.mvn/wrapper
.mvn/wrapper
 
 
src
src
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
mvnw
mvnw
 
 
mvnw.cmd
mvnw.cmd
 
 
pom.xml
pom.xml
 
 

Repository files navigation

RESTFUL API for Running Club Site

Feel free to use & modify this API for register running club with its event

1. User Management

a. Register User

Endpoint : POST /api/users

Request Header : None

Allowed User : Any Role

Request Body:

{
    "username" : "username",
    "password" : "password",
    "role" : "ROLE_ADMIN / ROLE_USER"
}

Response Body:

{
    "status": true,
    "messages": "User registration success",
    "errors": null,
    "data": {
        "username": "username",
        "role": [
            {
                "role": "ROLE_ADMIN"
            }
        ]
    }
}

b. Get Current User

Endpoint : GET /api/users/current

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Response Body:

{
    "status": true,
    "messages": "User fetching success",
    "errors": null,
    "data": {
        "username": "username",
        "role": [
            {
                "role": "ROLE_ADMIN"
            }
        ]
    }
}

c. Update User Password

Endpoint : PATCH /api/users/current

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body:

{
    "username" : "username",
    "password" : "password"    
}

Response Body:

{
    "status": true,
    "messages": "User password update success",
    "errors": null,
    "data": {
        "username": "bintang.ginanjar",
        "role": [
            {
                "role": "ROLE_ADMIN"
            }
        ]
    }
}

d. Update User Role

Endpoint : PATCH /api/users/role

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN

Request Body:

{
    "username" : "username",
    "password" : "password"    
}

Response Body:

{
    "status": true,
    "messages": "User role update success",
    "errors": null,
    "data": {
        "username": "username",
        "role": [
            {
                "role": "ROLE_USER"
            }
        ]
    }
}

e. Get All User

Endpoint : GET /api/users/list

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN

Response Body:

{
    "status": true,
    "messages": "User fetching success",
    "errors": null,
    "data": [
        {
            "username": "test",
            "role": [
                {
                    "role": "ROLE_ADMIN"
                }
            ]
        },
        {
            "username": "bintang.ginanjar",
            "role": [
                {
                    "role": "ROLE_USER"
                }
            ]
        },
        {
            "username": "admin",
            "role": [
                {
                    "role": "ROLE_ADMIN"
                }
            ]
        }
    ]
}

2. Auth Management

a. User Login

Endpoint : POST /api/auth/login

Request Header : None

Allowed User : Any Role

Request Body:

{
    "username" : "username",
    "password" : "password"
}

Response Body:

{
    "status": true,
    "messages": "Login success",
    "errors": null,
    "data": {
        "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJiaW50YW5nLmdpbmFuamFyIiwiaWF0IjoxNzM4OTAxNzM2LCJleHAiOjE3Mzk2MjE3MzZ9.UEZL76NRFLfYJ8vQNFjnvFc0thuoX9sL6qNen_yyMYIgGUiGozfJf10HG-Lb66Rs-RB7WdVfN4cl4yPqroUSzA",
        "roles": [
            "ROLE_ADMIN"
        ],
        "tokenType": "Bearer "
    }
}

b. User Logout

Endpoint : DELETE /api/auth/logout

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Response Body:

{
    "status": true,
    "messages": "User logout successfully",
    "errors": null,
    "data": null
}

3. Club Management

a. Register Club

Endpoint : POST /api/clubs

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body:

{
    "title" : "Daytona Running Club",
    "content" : "Daytona Content",
    "photoUrl" : "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
}

Response Body:

{
    "status": true,
    "messages": "Club registration success",
    "errors": null,
    "data": {
        "id": 4,
        "title": "Daytona Running Club",
        "photoUrl": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg",
        "content": "Daytona Content"
    }
}

b. Get Club by Id

Endpoint : GET /api/clubs/{clubId}

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body: None

Response Body:

{
    "status": true,
    "messages": "Club fetching success",
    "errors": null,
    "data": {
        "id": 4,
        "title": "Daytona Running Club",
        "photoUrl": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg",
        "content": "Daytona Content"
    }
}

c. Update Club

Endpoint : PATCH /api/clubs/{clubId}

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body:

{
    "title" : "Daytona Running Club",
    "content" : "Daytona Content",
    "photoUrl" : "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
}

Response Body:

{
    "status": true,
    "messages": "Club update success",
    "errors": null,
    "data": {
        "id": 4,
        "title": "Daytona Running Club",
        "photoUrl": "https://img.freepik.com/free-photo/young-happy-sportswoman-running-road-morning-copy-space_637285-3758.jpg",
        "content": "Daytona Content"
    }
}

c. Update Club

Endpoint : PATCH /api/clubs/{clubId}

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body:

{
    "title" : "Daytona Running Club",
    "content" : "Daytona Content",
    "photoUrl" : "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
}

Response Body:

{
    "status": true,
    "messages": "Club update success",
    "errors": null,
    "data": {
        "id": 4,
        "title": "Daytona Running Club",
        "photoUrl": "https://img.freepik.com/free-photo/young-happy-sportswoman-running-road-morning-copy-space_637285-3758.jpg",
        "content": "Daytona Content"
    }
}

d. Delete Club

Endpoint : DELETE /api/clubs/{clubId}

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body: None

Response Body:

{
    "status": true,
    "messages": "Club delete success",
    "errors": null,
    "data": null
}

e. Get All Club

Endpoint : GET /api/clubs

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN

Request Body: None

Response Body:

{
    "status": true,
    "messages": "Club fetching success",
    "errors": null,
    "data": [
        {
            "id": 4,
            "title": "Daytona Running Club",
            "photoUrl": "Daytona Content",
            "content": "https://img.freepik.com/free-photo/young-happy-sportswoman-running-road-morning-copy-space_637285-3758.jpg"
        },
        {
            "id": 5,
            "title": "Arizona Running Club",
            "photoUrl": "Arizona Content",
            "content": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
        }
    ]
}

f. Get All Club by User

Endpoint : GET /api/clubs/list

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body: None

Response Body:

{
    "status": true,
    "messages": "Club fetching success",
    "errors": null,
    "data": [
        {
            "id": 7,
            "title": "Boston Running Club",
            "photoUrl": "Boston Content",
            "content": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
        }
    ]
}

4. Event Management

a. Register Event

Endpoint : POST /api/clubs/{clubId}/events

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body:

{
    "clubId" : "7",
    "name" : "Boston Running Club Event",
    "startTime" : "10-02-2025",
    "endTime" : "10-02-2025",
    "type" : "Fun Run",
    "photoUrl" : "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
}

Response Body:

{
    "status": true,
    "messages": "Event registration success",
    "errors": null,
    "data": {
        "id": 1,
        "name": "Boston Running Club Event",
        "startTime": "10-02-2025",
        "endTime": "10-02-2025",
        "type": "Fun Run",
        "photoUrl": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
    }
}

b. Get Event by Id

Endpoint : GET /api/clubs/{clubId}

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body: None

Response Body:

{
    "status": true,
    "messages": "Event fetching success",
    "errors": null,
    "data": {
        "id": 2,
        "name": "Nevada Running Club Event",
        "startTime": "11-02-2025",
        "endTime": "11-02-2025",
        "type": "Fun Run",
        "photoUrl": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
    }
}

c. Update Club

Endpoint : PATCH /api/clubs/{clubId}/events/{eventId}

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body:

{
    "clubId" : "8",
    "eventId" : "2",
    "name" : "Nevada Running Club Event",
    "startTime" : "14-02-2025",
    "endTime" : "14-02-2025",
    "type" : "Fun Run on Desert",
    "photoUrl" : "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
}

Response Body:

{
    "status": true,
    "messages": "Event update success",
    "errors": null,
    "data": {
        "id": 2,
        "name": "Nevada Running Club Event",
        "startTime": "14-02-2025",
        "endTime": "14-02-2025",
        "type": "Fun Run on Desert",
        "photoUrl": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
    }
}

d. Delete Club

Endpoint : DELETE /api/clubs/{clubId}/events/{eventId}

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body: None

Response Body:

{
    "status": true,
    "messages": "Event delete success",
    "errors": null,
    "data": null
}

e. Get Event by User

Endpoint : GET /api/events/list

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN
  • ROLE_USER

Request Body: None

Response Body:

{
    "status": true,
    "messages": "Event fetching success",
    "errors": null,
    "data": [
        {
            "id": 1,
            "name": "Boston Running Club Event",
            "startTime": "10-02-2025",
            "endTime": "10-02-2025",
            "type": "Fun Run",
            "photoUrl": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
        },
        {
            "id": 3,
            "name": "Nevada Running Club Event on Summer",
            "startTime": "11-08-2025",
            "endTime": "11-08-2025",
            "type": "Fun Run Summer",
            "photoUrl": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
        }
    ]
}

f. Get All Events

Endpoint : GET /api/events

Request Header :

  • Authorization : "Bearer " + Token (mandatory)

Allowed User :

  • ROLE_ADMIN

Request Body: None

Response Body:

{
    "status": true,
    "messages": "Event fetching success",
    "errors": null,
    "data": [
        {
            "id": 1,
            "name": "Boston Running Club Event",
            "startTime": "10-02-2025",
            "endTime": "10-02-2025",
            "type": "Fun Run",
            "photoUrl": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
        },
        {
            "id": 3,
            "name": "Nevada Running Club Event on Summer",
            "startTime": "11-08-2025",
            "endTime": "11-08-2025",
            "type": "Fun Run Summer",
            "photoUrl": "https://img.freepik.com/free-photo/young-attractive-fitness-girl-jogging_176420-824.jpg"
        }
    ]
}

About

A robust, secure and simple running clubs restful API

Topics

java spring-boot spring-mvc java-spring-boot

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages