brewery/export-service
It is a service created for Export processes. The project was written with Nest Framework.
Image
0
1.7K
brewery/export-service repository overview
EXPORT SERVICE
Description
It is a service created for Export processes. The project was written with Nest Framework.
Instructions
Docker Compose
By creating the docker-compose.yml file, it is possible to deploy the project with docker commands below. You can visit the Docker Hub Repository to review the versions.
version: "3"
services:
serve:
container_name: export-service
image: brewery/export-service:latest
expose:
- ${PORT}
restart: always
ports:
- "${PORT}:${PORT}"
env_file:
- .env
$ docker-compose up -d
Environment Variables
| Variable Name | Description | Required | Default |
|---|---|---|---|
| ENVIRONMENT | Specifies the environment name. If the environment name is given as dev, Swagger operates actively. | NO | dev |
| CORS | Website endpoints can be defined for Cors safety. | NO | * |
| PORT | It is determined which port will be deploy. | NO | 3000 |
| GLOBAL_PREFIX | Allows to add additional pathname to the service end. | NO | - |
| BODY_SIZE_LIMIT | Specifies the maximum size of the data that will come from the body during the request. | NO | 5mb |
| API_KEY | It allows to add an api key control to the service for security during service use. | NO | - |
Request Examples
HTML to PDF
The parameters that can be sent in the body are in the table below.
| Key | Description | Required | Type | Defult |
|---|---|---|---|---|
| fileName | Created PDF file represents its name. | YES | string | - |
| type | Determines the type of transformation of the incoming data. | YES | enum(Html, Url) | - |
| html | HTML string to be converted to PDF is sent in format. | NO | string | - |
| url | The HTML response that comes with the request for GET is converted to PDF. | NO | string | - |
| format | Specifies the PDF page size. | YES | enum(Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6) | - |
| responseType | Specifies the type that the service will return. | YES | enum(Stream, Base64) | - |
REQ
// POST {{ENDPOINT}}/{{GLOBAL_PREFIX}}/html-to-pdf
{
"url": "https://google.com.tr",
"type": "url",
"fileName": "hello-word",
"format": "a3",
"responseType": "stream"
}
// POST {{ENDPOINT}}/{{GLOBAL_PREFIX}}/html-to-pdf
{
"html": "<h1>Hello Word</h1>",
"type": "html",
"fileName": "hello-word",
"format": "a2",
"responseType": "stream"
}
License
Export Service is MIT licensed.
Tag summary
Content type
Image
Digest
sha256:e8be2e0ce…
Size
356 MB
Last updated
about 4 years ago
docker pull brewery/export-service