url2png/api-documentation.json at master · spatialdev/url2png · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
{
    "swagger": "2.0",
    "info": {
        "title": "Url2Png API",
        "description": "Convert a URL to a PNG image and download.",
        "version": "1.0.0"
    },
    "host": "",
    "schemes": [
        ""
    ],
    "basePath": "",
    "produces": [
        "application/json"
    ],
    "paths": {
        "/url2png": {
            "post": {
                "summary": "Convert webpage to PNG.",
                "description": "The url2png endpoint accepts a URL and returns a link to download a PNG representation of the web page at the URL.",
                "parameters": [
                    {
                        "name": "url",
                        "in": "body",
                        "description": "URL of webpage to convert",
                        "required": true,
                        "type": "string"
                    },
                    {
                        "name": "viewport_width",
                        "in": "body",
                        "description": "The width of the produced PNG (default is 1440px)",
                        "required": false,
                        "type": "number",
                        "format": "integer"
                    },
                    {
                        "name": "delay",
                        "in": "body",
                        "description": "The time delay (ms) before executing image capture (default is 5000 ms)",
                        "required": false,
                        "type": "number",
                        "format": "integer"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "An object with success message and link to download the image.",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "message": {
                                    "type": "string",
                                    "description": "success"
                                },
                                "downloadURL": {
                                    "type": "string",
                                    "description": "The relative URL for download of the captured image. Root will be the same as the API."
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "Error due to failure to submit required parameters.",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "message" : {
                                    "type" : "string",
                                    "description" : "No URL to print in post data"
                                }
                            }
                        }
                    },
                    "500" : {
                        "description": "Server error.",
                        "schema": {
                            "type": "object",
                            "properties": {
                                "message" : {
                                    "type" : "string",
                                    "description" : "Error message"
                                },
                                "error" : {
                                    "type": "object",
                                    "description": "Error object."
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}