Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ludwigandreas/spring_rest_api

This document provides an overview and documentation for the LifeTracker REST API service. It describes the available endpoints, request and response formats, and provides examples for common use cases, security configuration and token usage.
https://github.com/ludwigandreas/spring_rest_api

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/ludwigandreas/spring_rest_api
Owner: LudwigAndreas
Created: 2023-05-21T22:23:58.000Z (over 1 year ago)
Default Branch: develop
Last Pushed: 2023-06-21T14:30:08.000Z (over 1 year ago)
Last Synced: 2024-11-07T12:47:42.291Z (about 2 months ago)
Language: Java
Homepage:
Size: 165 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# EternalTimeline API Documentation

## Introduction

## Table of content
- [Base URL](#base-url)
- [Authentication](#authentication)
- [signup](#signup)
- [login](#login)
- [logout](#logout)
- [logout-all](#logout-all)
- [access-token](#access-token)
- [refresh-token](#refresh-token)
- [Endpoints](#endpoints)
- [User](#user)
- [delete](#delete-user)
- [get](#get-user)
- [patch](#patch-user)
- [update](#update-user)
- [Workflow](#workflow)
- [delete](#workflow-delete-endpoint)
- [get](#workflow-get-endpoint)
- [insert](#workflow-insert-endpoint)
- [list](#workflow-list-endpoint)
- [patch](#workflow-patch-endpoint)
- [update](#workflow-update-endpoint)
- [Project](#project)
- [delete](#project-delete-endpoint)
- [get](#project-get-endpoint)
- [insert](#project-insert-endpoint)
- [list](#project-list-endpoint)
- [patch](#project-patch-endpoint)
- [update](#project-update-endpoint)
- [Event](#event)
- [delete](#event-delete-endpoint)
- [get](#event-get-endpoint)
- [import](#event-import-endpoint)
- [insert](#event-insert-endpoint)
- [instances](#event-instances-endpoint)
- [list](#event-list-endpoint)
- [move](#event-move-endpoint)
- [patch](#event-patch-endpoint)
- [update](#event-update-endpoint)
- [Error Handling](#error-handling)
- [Conclusion](#conclusion)

## Base URL

The base URL for accessing the API service is:
`https://eternaltimeline.ru/api`

## Authentication

To access the API service, you need to include an authentication token in the request header. The token should be included in the `Authorization` header field using the `Bearer` authentication scheme.

If you are a new user, you need to send a request to "", after which you will get your UserId AccessToken and RefreshToken.

### Signup
`POST /auth/signup`

Endpoint allows you to create a new user. It requires the following parameters:

- `username`: \[string](required) unique username
- `email`: \[string](required) unique email
- `password`: \[string](required) password
- `firstname`: \[string](optional) firstname
- `lastname`: \[string](optional) lastname

#### Request
```http
POST /signup HTTP/1.1
Content-Type: application/json

{
"username": "YourUsername",
"email": "[email protected]",
"firstname": "ludwig",
"firstname": "andreas",
"password": "YourPassword123"
}
```

#### Response
```json
{
"user_id": "1234a56-789b-01cd-d23e-4567f8j9h0i1",
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2V4YW1wbGUuYXV0aDAuY29tLyIsImF1ZCI6Imh0dHBzOi8vYXBpLmV4YW1wbGUuY29tL2NhbGFuZGFyL3YxLyIsInN1YiI6InVzcl8xMjMiLCJpYXQiOjE0NTg3ODU3OTYsImV4cCI6MTQ1ODg3MjE5Nn0.CA7eaHjIHz5NxeIJoFK9krqaeZrPLwmMmgI_XiQiIkQ",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2V4YW1wbGUuYXV0aDAuY29tLyIsImF1ZCI6Imh0dHBzOi8vYXBpLmV4YW1wbGUuY29tL2NhbGFuZGFyL3YxLyIsInN1YiI6InVzcl8xMjMiLCJpYXQiOjE0NTg3ODU3OTYsImV4cCI6MTQ1ODg3MjE5Nn0.CA7eaHjIHz5NxeIJoFK9krqaeZrPLwmMmgI_XiQiIkQ"
}
```

If you already have an account, you can use the login form

### Login

`POST /auth/login`

Endpoint allows you to login. It requires the following parameters:

- `username`: \[string](required) your username
- `password`: \[string](required) password

#### Request
```http
POST /login HTTP/1.1
Content-Type: application/json

{
"username": "YourUsername",
"password": "YourPassword123"
}
```

With each authorization, a new refreshToken is created, which you can use to access resources.

If you need to log out you can use next endpoint:

### Logout

`POST /auth/logout`

Endpoint allows you to logout. It requires the following parameters:

- `user_id`: \[string](required) your user_id
- `access_token`: \[string](required) your access token
- `refresh_token`: \[string](required) your refresh token

#### Request
```http
POST /logout HTTP/1.1
Content-Type: application/json

{
"user_id": "1234a56-789b-01cd-d23e-4567f8j9h0i1",
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2V4YW1wbGUuYXV0aDAuY29tLyIsImF1ZCI6Imh0dHBzOi8vYXBpLmV4YW1wbGUuY29tL2NhbGFuZGFyL3YxLyIsInN1YiI6InVzcl8xMjMiLCJpYXQiOjE0NTg3ODU3OTYsImV4cCI6MTQ1ODg3MjE5Nn0.CA7eaHjIHz5NxeIJoFK9krqaeZrPLwmMmgI_XiQiIkQ",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2V4YW1wbGUuYXV0aDAuY29tLyIsImF1ZCI6Imh0dHBzOi8vYXBpLmV4YW1wbGUuY29tL2NhbGFuZGFyL3YxLyIsInN1YiI6InVzcl8xMjMiLCJpYXQiOjE0NTg3ODU3OTYsImV4cCI6MTQ1ODg3MjE5Nn0.CA7eaHjIHz5NxeIJoFK9krqaeZrPLwmMmgI_XiQiIkQ"
}
```

#### Response
```json
```

The query will result in an empty body and the execution status can be tracked via the response status

### Logout-all

`POST /auth/logout-all`

Endpoint allows you to logout all your devices. It requires the following parameters:

- `user_id`: \[string](required) your user_id
- `access_token`: \[string](required) your access token
- `refresh_token`: \[string](required) your refresh token

#### Request
```http
POST /logout-all HTTP/1.1
Content-Type: application/json

#### Response
```json

```

Works just the same as `/logout` but logout all devices

### Access-token

`POST /auth/access-token`

Generates new access-token using refresh-token

- `user_id`: \[string](required) your user_id
- `refresh_token`: \[string](required) your refresh token

#### Request
```http
POST /access-token HTTP/1.1
Content-Type: application/json

{
"user_id": "1234a56-789b-01cd-d23e-4567f8j9h0i1",
"refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2V4YW1wbGUuYXV0aDAuY29tLyIsImF1ZCI6Imh0dHBzOi8vYXBpLmV4YW1wbGUuY29tL2NhbGFuZGFyL3YxLyIsInN1YiI6InVzcl8xMjMiLCJpYXQiOjE0NTg3ODU3OTYsImV4cCI6MTQ1ODg3MjE5Nn0.CA7eaHjIHz5NxeIJoFK9krqaeZrPLwmMmgI_XiQiIkQ"
}
```

### Refresh-token

`POST /auth/refresh-token`

Generates new access-token and refresh-token using refresh-token

- `user_id`: \[string](required) your user_id
- `refresh_token`: \[string](required) your refresh token

#### Request
```http
POST /logout HTTP/1.1
Content-Type: application/json

## Endpoints

### User
User contains all info about user.

#### Delete user

`DELETE /users/{userId}`

/users allows you to delete all user data. It supports the following parameters:

- `userId`: (required) userId as it's provided after authentication.

##### Request

```http
DELETE /users/{id} HTTP/1.1
Authorization: Bearer
```

##### Response
```json
{
"id": "1234a56-789b-01cd-d23e-4567f8j9h0i1"
}
```

#### Get user

`GET /users/{id}`

/users allows you to retrieve a user data. It supports the following parameters:

- `userId`: (required) userId as it's provided after authentication.

##### Request

```http
GET /users/{id} HTTP/1.1
Authorization: Bearer
```

##### Response
```json
{
"id": "1234a56-789b-01cd-d23e-4567f8j9h0i1",
"username": "lsherry",
"firstname": "Ludwig",
"lastname": "Andreas",
"email": "[email protected]",
"created_date": "2023-05-18",
"last_updated_date": "2023-05-18"
}
```

#### Patch user

`PATCH /users/{id}`

/users allows you to change a user data. Supports JSON Patch that specified in RFC 6902 from the IETF.

- `userId`: (required) userId as it's provided after authentication.

##### Request

```http
GET /users/{id} HTTP/1.1
Authorization: Bearer

[
{ "op": "replace", "path": "/username", "value": "lsherry_new" },
{ "op": "replace", "path": "/firstname", "value": "Restalw" },
{ "op": "replace", "path": "/email", "value": "[email protected]" }
]
```

##### Response
```json
{
"id": "1234a56-789b-01cd-d23e-4567f8j9h0i1",
"username": "lsherry_new",
"firstname": "Restalw",
"lastname": "Andreas",
"email": "[email protected]",
"created_date": "2023-05-18",
"last_updated_date": "2023-05-18"
}
```

#### Update user

`PUT /users/{id}`

**/users** allows you to change whole user data. It supports the following parameters:

- `userId`: (required) userId as it's provided after authentication.
- `username`: (optional) userId as it's provided after authentication.
- `firstname`: (optional) userId as it's provided after authentication.
- `lastname`: (optional) userId as it's provided after authentication.
- `email`: (optional) userId as it's provided after authentication.
- `password`: (optional) userId as it's provided after authentication.~~

##### Request

```http
GET /users/{id} HTTP/1.1
Authorization: Bearer

{
"id": "1234a56-789b-01cd-d23e-4567f8j9h0i1",
"username": "lsherry_new",
"firstname": "Restalw",
"lastname": "Andreas",
"email": "[email protected]",
"created_date": "2023-05-18",
"last_updated_date": "2023-05-18"
}
```

### Workflow

Documentation not provided yet

### Project

Documentation not provided yet

### Event

Documentation not provided yet

## Error Handling
In case of errors, the API service returns appropriate HTTP status codes along with error messages in the response body.

Here are some common error codes:

`400 Bad Request`: The request was invalid or could not be understood.
`401 Unauthorized`: The request lacks valid authentication credentials.
`404 Not Found`: The requested resource could not be found.
`409 Conflict`: The request can not be performed because of conflict of user's data.

## Conclusion
This concludes the documentation for the REST API service. Please refer to the specific endpoint details for more information on how to use the API.

If you have any further questions or need assistance, please contact our support team.