https://github.com/itsjimi/pdf-api
Convert HTML to PDF with a single endpoint
https://github.com/itsjimi/pdf-api
html pdf pdf-generation
Last synced: about 1 year ago
JSON representation
Convert HTML to PDF with a single endpoint
- Host: GitHub
- URL: https://github.com/itsjimi/pdf-api
- Owner: ItsJimi
- License: mit
- Created: 2019-05-10T12:06:54.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-12T15:47:46.000Z (over 1 year ago)
- Last Synced: 2024-12-12T16:37:09.213Z (over 1 year ago)
- Topics: html, pdf, pdf-generation
- Language: Go
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pdf-api
Convert `HTML` to `PDF` with a single endpoint.
## Install
Be sure to install [wkhtmltopdf](https://wkhtmltopdf.org/) before using `pdf-api`.
## Launch
```
$ PORT=3000 pdf-api
```
## Endpoints
### Generate
#### Arguments
```
(String) orientation: "[portrait|landscape]"
(String) url: ""
(String) html: ""
```
`url` or `html` are required
#### Request
```request
GET /generate
```
```
?orientation=[portrait|landscape] &url=https://google.fr &html=Hello
```
#### Response
##### Error
```json
{
"msg": "error message"
}
```
##### Success
Your pdf file
#### Request
```request
POST /generate
```
```json
{
"orientation": "[portrait|landscape]",
"url": "https://google.fr",
"html": "Hello"
}
```
#### Response
##### Error
```json
{
"msg": "error message"
}
```
##### Success
Your pdf file
## License
[MIT](https://github.com/ItsJimi/pdf-api/blob/master/LICENSE)