forked from loafle/openapi-generator-original
44 lines
1.1 KiB
Plaintext
44 lines
1.1 KiB
Plaintext
# {{artifactId}}
|
|
|
|
## Requirements
|
|
|
|
Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
|
|
|
|
## Installation & Usage
|
|
|
|
To install the API client library to your local Maven repository, simply execute:
|
|
|
|
```shell
|
|
mvn install
|
|
```
|
|
|
|
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
|
|
|
|
```shell
|
|
mvn deploy
|
|
```
|
|
|
|
Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
|
|
|
|
After the client libarary is installed/deployed, you can use it in your Maven project by adding the following to your *pom.xml*:
|
|
|
|
```xml
|
|
<dependency>
|
|
<groupId>{{groupId}}</groupId>
|
|
<artifactId>{{artifactId}}</artifactId>
|
|
<version>{{artifactVersion}}</version>
|
|
<scope>compile</scope>
|
|
</dependency>
|
|
|
|
```
|
|
|
|
## Recommendation
|
|
|
|
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issue.
|
|
|
|
## Author
|
|
|
|
{{#apiInfo}}{{#apis}}{{^hasMore}}{{infoEmail}}
|
|
{{/hasMore}}{{/apis}}{{/apiInfo}}
|
|
|