# arex-api

**Repository Path**: zohardev/arex-api

## Basic Information

- **Project Name**: arex-api
- **Description**: Central hub for API interfaces used by AREX's frontend, facilitating effective UI interactions.
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-06-09
- **Last Updated**: 2024-06-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center"><h1>AREX API Service</h1></div>

## Introduction

This repository serves as the backbone for AREX's frontend, offering a comprehensive collection of API interfaces necessary for seamless user interface interaction and functionality.

## API Documentation

To ensure easy accessibility and understanding of our API interfaces, we utilize Swagger 3. This tool helps in generating clear and interactive documentation. You can view the API documentation by deploying the project and visiting: `http://[your-deployed-ip-and-port]/swagger-ui/index.html`. A visual glimpse of our Swagger UI is provided below for reference.

![Swagger UI Screenshot](documents/screenshots/swagger.png)

## LICENSE

```text
Copyright (C) 2022 ArexTest

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see https://www.gnu.org/licenses/.
```