Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/panosoft/prince-server
https://github.com/panosoft/prince-server
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/panosoft/prince-server
- Owner: panosoft
- Created: 2016-02-01T19:42:14.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-04T23:07:32.000Z (almost 9 years ago)
- Last Synced: 2023-04-10T13:46:22.016Z (over 1 year ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Prince server
> A PrinceXml rendering server.
[](https://www.npmjs.com/package/@panosoft/prince-server)
[](https://travis-ci.org/panosoft/prince-server)
# Installation
```sh
npm install -g @panosoft/prince-server
```
# Usage
```sh
Usage: prince-server --key --cert [options]
A PrinceXml rendering server.
Options:
-h, --help output usage information
-V, --version output the version number
-k, --key Path to the private key of the server in PEM format.
-c, --cert Path to the certificate key of the server in PEM format.
-p, --port The port to accept connections on. Default: 8443.
-i, --interface The interface to accept connections on. Default: 0.0.0.0.
```
# HTTPS API
## Request
- Path: `/`
- Method: `POST`
- Headers:
- `Content-Type` - `'application/json'`
- Body:
- `input` - {String} The html string to render.
- `[options]` - {\*} The options to pass to the prince command at runtime.
## Responses
__Success__
- Status Code: `200`
- Headers:
- `Request-Id` - {String} The unique request identifier.
- `Content-Type` - `'application/pdf'`
- Body: {Buffer} The pdf binary.
__Error__
- Status Code: `500`
- Headers:
- `Request-Id` - {String} The unique request identifier.
- `Content-Type` - `'application/json'`
- Body:
- `error` - {String} The error message.