koochooloo/api/swagger.yml at main · 1995parham/koochooloo · 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
---
openapi: 3.0.0

info:
  title: koochooloo
  description: Make your URLs shorter (smaller) and more memorable
  version: 1.0.0

servers:
  - url: /api

paths:
  /urls:
    post:
      summary: Create a short version of given URL
      requestBody:
        required: true
        content:
          application/json:
            examples:
              without-name:
                summary: Random Short URL
                value:
                  url: https://www.google.com
              with-name:
                summary: Explicit Short URL
                value:
                  url: https://www.google.com
                  name: google
              with-expiration:
                summary: Random Short URL with Expiration
                value:
                  url: https://www.google.com
                  expire: "2011-08-30T13:22:53.108Z"
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                name:
                  type: string
                expire:
                  type: string
                  format: date-time
              required:
                - url
      responses:
        200:
          description: Successfully created a short URL record
          content:
            application/json:
              examples:
                without-name:
                  summary: Random Short URL
                  value: CKaniA
                with-name:
                  summary: Explicit Short URL
                  value: $google
                with-expiration:
                  summary: Random Short URL with Expiration
                  value: CKaniA
              schema:
                type: string
                example: CKaniA
  /urls/{short}:
    get:
      summary: Redirect to URL of given short version
      parameters:
        - in: path
          name: short
          example: CKaniA
          schema:
            type: string
          required: true
      responses:
        302:
          description: Redirect to URL of given short version