Archived
3
0
Fork 1
This repository has been archived on 2025-01-10. You can view files and clone it, but cannot push or open issues or pull requests.
docs/vehiclesplus-v3/api/gettingstarted.md

61 lines
1.6 KiB
Markdown
Raw Normal View History

2024-12-28 20:10:46 +00:00
---
2024-12-28 21:08:28 +00:00
title: Getting Started
description: Api usage
2024-12-28 20:11:33 +00:00
published: false
date: 2024-12-28T22:25:49.881Z
2024-12-28 20:10:46 +00:00
tags: developers
editor: markdown
dateCreated: 2024-12-28T20:10:42.650Z
---
# API Usage
2024-12-28 20:10:46 +00:00
This guide explains how to integrate the new and improved VehiclesPlus API (v3) into your project.
2024-12-28 20:10:46 +00:00
## Adding VehiclesPlus to Your Project
2024-12-28 20:10:46 +00:00
To use the VehiclesPlus API in your plugin, follow these steps:
2024-12-28 20:10:46 +00:00
### Step 1: Add VehiclesPlus to Your Dependencies
2024-12-28 20:10:46 +00:00
Ensure VehiclesPlus is added as a dependency in your project. To always use the latest version, update your dependency configuration as shown below:
2024-12-28 20:40:27 +00:00
Maven (`pom.xml`):
2024-12-28 20:10:46 +00:00
```xml
<repository>
<id>sbdevelopment-repo</id>
<url>https://repo.sbdevelopment.tech/releases</url>
</repository>
2024-12-28 20:10:46 +00:00
<dependency>
<groupId>tech.sbdevelopment</groupId>
<artifactId>vehiclesplus</artifactId>
<version>latest</version>
</dependency>
```
2024-12-28 20:40:27 +00:00
Gradle (`build.gradle`):
```gradle
repositories {
maven {
url 'https://repo.sbdevelopment.tech/releases'
2024-12-28 20:10:46 +00:00
}
}
dependencies {
implementation 'tech.sbdevelopment:vehiclesplus:latest'
2024-12-28 20:10:46 +00:00
}
```
> **Note**: Using `latest` ensures that your project always fetches the most recent release, but it might cause issues if breaking changes are introduced. For more stability, consider specifying a specific version (e.g., `3.0.2`).
{.is-info}
2024-12-28 21:15:13 +00:00
## Examples
For usage examples, please visit the [VehiclesPlus Examples Page](https://docs.sbdevelopment.tech/en/vehiclesplus-v3/api/gettingstarted).
## API Documentation
2024-12-28 20:38:37 +00:00
For additional details and advanced usage refer to the official [VehiclesPlus Javadoc](https://sbdevelopment.tech/javadoc/vehiclesplus-v3/index.html).