code-exercise-java/openapi.yaml at main · tpximpact/code-exercise-java · 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
openapi: 3.0.3
info:
  title: URL Shortener API
  version: 1.0.0
  description: Simple RESTful API for shortening URLs.

paths:
  /shorten:
    post:
      summary: Shorten a URL
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - fullUrl
              properties:
                fullUrl:
                  type: string
                  example: https://example.com/very/long/url
                customAlias:
                  type: string
                  example: my-custom-alias
      responses:
        '201':
          description: URL successfully shortened
          content:
            application/json:
              schema:
                type: object
                properties:
                  shortUrl:
                    type: string
                    example: http://localhost:8080/my-custom-alias
        '400':
          description: Invalid input or alias already taken

  /{alias}:
    get:
      summary: Redirect to full URL
      parameters:
        - name: alias
          in: path
          required: true
          schema:
            type: string
      responses:
        '302':
          description: Redirect to the original URL
        '404':
          description: Alias not found

    delete:
      summary: Delete a shortened URL
      parameters:
        - name: alias
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Successfully deleted
        '404':
          description: Alias not found

  /urls:
    get:
      summary: List all shortened URLs
      responses:
        '200':
          description: A list of shortened URLs
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    alias:
                      type: string
                      example: my-custom-alias
                    fullUrl:
                      type: string
                      example: https://example.com/very/long/url
                    shortUrl:
                      type: string
                      example: http://localhost:8080/my-custom-alias