Skip to content

Commit 8c41159

Browse files
AndyRadzikhovskyAndyRadzikhovsky
authored
Create README.md
1 parent db293b9 commit 8c41159

File tree

1 file changed

+158
-0
lines changed

1 file changed

+158
-0
lines changed

‎README.md‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
# aspose-html-cloud-java
2+
Java library for communicating with the Aspose.HTML for Cloud API
3+
4+
## Requirements
5+
6+
Building the API client library requires [Maven](https://maven.apache.org/) to be installed.
7+
8+
## Installation
9+
10+
To install the API client library to your local Maven repository, simply execute:
11+
12+
```shell
13+
mvn install
14+
```
15+
16+
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
17+
18+
```shell
19+
mvn deploy
20+
```
21+
22+
Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.
23+
24+
### Maven users
25+
26+
Add this dependency to your project's POM:
27+
28+
```xml
29+
<dependency>
30+
<groupId>io.swagger</groupId>
31+
<artifactId>swagger-java-client</artifactId>
32+
<version>1.0.0</version>
33+
<scope>compile</scope>
34+
</dependency>
35+
```
36+
37+
### Gradle users
38+
39+
Add this dependency to your project's build file:
40+
41+
```groovy
42+
compile "io.swagger:swagger-java-client:1.0.0"
43+
```
44+
45+
### Others
46+
47+
At first generate the JAR by executing:
48+
49+
mvn package
50+
51+
Then manually install the following JARs:
52+
53+
* target/swagger-java-client-1.0.0.jar
54+
* target/lib/*.jar
55+
56+
## Getting Started
57+
58+
Please follow the [installation](#installation) instruction and execute the following Java code:
59+
60+
```java
61+
62+
import com.aspose.html.client.invoker.*;
63+
import com.aspose.html.client.invoker.auth.*;
64+
import com.aspose.html.client.model.*;
65+
import com.aspose.html.client.api.ConversionApi;
66+
67+
import java.io.File;
68+
import java.util.*;
69+
70+
public class ConversionApiExample {
71+
72+
public static void main(String[] args) {
73+
74+
ConversionApi apiInstance = new ConversionApi();
75+
String name = "name_example"; // String | Document name.
76+
String outFormat = "outFormat_example"; // String | Resulting image format.
77+
Integer width = 56; // Integer | Resulting image width.
78+
Integer height = 56; // Integer | Resulting image height.
79+
Integer leftMargin = 56; // Integer | Left resulting image margin.
80+
Integer rightMargin = 56; // Integer | Right resulting image margin.
81+
Integer topMargin = 56; // Integer | Top resulting image margin.
82+
Integer bottomMargin = 56; // Integer | Bottom resulting image margin.
83+
Integer xResolution = 56; // Integer | Horizontal resolution of resulting image.
84+
Integer yResolution = 56; // Integer | Vertical resolution of resulting image.
85+
String folder = "folder_example"; // String | The document folder.
86+
String storage = "storage_example"; // String | The document storage.
87+
try {
88+
File result = apiInstance.conversionGetConvertDocumentToImage(name, outFormat, width, height, leftMargin, rightMargin, topMargin, bottomMargin, xResolution, yResolution, folder, storage);
89+
System.out.println(result);
90+
} catch (ApiException e) {
91+
System.err.println("Exception when calling ConversionApi#conversionGetConvertDocumentToImage");
92+
e.printStackTrace();
93+
}
94+
}
95+
}
96+
97+
```
98+
99+
## Documentation for API Endpoints
100+
101+
All URIs are relative to *https://api.aspose.cloud/v1.1*
102+
103+
Class | Method | HTTP request | Description
104+
------------ | ------------- | ------------- | -------------
105+
*ConversionApi* | [**conversionGetConvertDocumentToImage**](docs/ConversionApi.md#conversionGetConvertDocumentToImage) | **GET** /html/{name}/convert/image/{outFormat} | Convert the HTML document from the storage by its name to the specified image format.
106+
*ConversionApi* | [**conversionGetConvertDocumentToImageByUrl**](docs/ConversionApi.md#conversionGetConvertDocumentToImageByUrl) | **GET** /html/convert/image/{outFormat} | Convert the HTML page from the web by its URL to the specified image format.
107+
*ConversionApi* | [**conversionGetConvertDocumentToPdf**](docs/ConversionApi.md#conversionGetConvertDocumentToPdf) | **GET** /html/{name}/convert/pdf | Convert the HTML document from the storage by its name to PDF.
108+
*ConversionApi* | [**conversionGetConvertDocumentToPdfByUrl**](docs/ConversionApi.md#conversionGetConvertDocumentToPdfByUrl) | **GET** /html/convert/pdf | Convert the HTML page from the web by its URL to PDF.
109+
*ConversionApi* | [**conversionGetConvertDocumentToXps**](docs/ConversionApi.md#conversionGetConvertDocumentToXps) | **GET** /html/{name}/convert/xps | Convert the HTML document from the storage by its name to XPS.
110+
*ConversionApi* | [**conversionGetConvertDocumentToXpsByUrl**](docs/ConversionApi.md#conversionGetConvertDocumentToXpsByUrl) | **GET** /html/convert/xps | Convert the HTML page from the web by its URL to XPS.
111+
*ConversionApi* | [**conversionPutConvertDocumentToImage**](docs/ConversionApi.md#conversionPutConvertDocumentToImage) | **PUT** /html/convert/image/{outFormat} | Convert the HTML document to the specified image format.
112+
*ConversionApi* | [**conversionPutConvertDocumentToPdf**](docs/ConversionApi.md#conversionPutConvertDocumentToPdf) | **PUT** /html/convert/pdf | Convert the HTML document to PDF.
113+
*ConversionApi* | [**conversionPutConvertDocumentToXps**](docs/ConversionApi.md#conversionPutConvertDocumentToXps) | **PUT** /html/convert/xps | Convert the HTML document to XPS.
114+
*DocumentApi* | [**documentGetDocument**](docs/DocumentApi.md#documentGetDocument) | **GET** /html/{name} | Return the HTML document by the name from default or specified storage.
115+
*DocumentApi* | [**documentGetDocumentFragmentByXPath**](docs/DocumentApi.md#documentGetDocumentFragmentByXPath) | **GET** /html/{name}/fragments/{outFormat} | Return list of HTML fragments matching the specified XPath query.
116+
*DocumentApi* | [**documentGetDocumentImages**](docs/DocumentApi.md#documentGetDocumentImages) | **GET** /html/{name}/images/all | Return all HTML document images packaged as a ZIP archive.
117+
*TranslationApi* | [**translationGetTranslateDocument**](docs/TranslationApi.md#translationGetTranslateDocument) | **GET** /html/{name}/translate/{srcLang}/{resLang} | Translate the HTML document specified by the name from default or specified storage.
118+
*TranslationApi* | [**translationGetTranslateDocumentByUrl**](docs/TranslationApi.md#translationGetTranslateDocumentByUrl) | **GET** /html/translate/{srcLang}/{resLang} | Translate the HTML document specified by its URL.
119+
*TranslationApi* | [**translationPutTranslateDocument**](docs/TranslationApi.md#translationPutTranslateDocument) | **PUT** /html/{name}/translate/{srcLang}/{resLang} | Translate the HTML document specified by the name from default or specified storage.
120+
*TranslationApi* | [**translationPutTranslateDocumentByUrl**](docs/TranslationApi.md#translationPutTranslateDocumentByUrl) | **PUT** /html/translate/{srcLang}/{resLang} | Translate the HTML document specified by its URL.
121+
122+
123+
## Documentation for Models
124+
125+
126+
127+
## Documentation for Authorization
128+
129+
Authentication schemes defined for the API:
130+
### appsid
131+
132+
- **Type**: API key
133+
- **API key parameter name**: appsid
134+
- **Location**: URL query string
135+
136+
### oauth
137+
138+
- **Type**: OAuth
139+
- **Flow**: application
140+
- **Authorization URL**: api.aspose.cloud/oauth2/token
141+
- **Scopes**: N/A
142+
143+
### signature
144+
145+
- **Type**: API key
146+
- **API key parameter name**: signature
147+
- **Location**: URL query string
148+
149+
150+
## Recommendation
151+
152+
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
153+
154+
## Author
155+
156+
157+
158+

0 commit comments

Comments
 (0)