API-documentary/index.html at main · OG-wura/API-documentary · 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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document API</title>
  <link rel="stylesheet" href="./index.css">
</head>
<body>
  <main>
    <!-- ======SIDE-BAR====== -->
    <section id="sidebar">
      <header>
        <h2>10-E-Commerce-DEV</h2>
        <p>Documentation for E-commerce API</p>
      </header>
      <!-- LINKS TO DIFFERENT SECTIONS -->
      <div class="links">
        <!-- BEGINNING OF AUTH SECTION -->
        <section class="auth">
          <ul>
            <li><b>Auth</b>
              <ol>
                <li><a href="#">Login User</a></li>
                <li><a href="#">Logout User</a></li>
                <li><a href="#">Register User</a></li>
              </ol>
            </li>
          </ul>
        </section>
        <!-- END OF AUTH SECTION -->

        <!-- BEGINNING OF ORDER SECTION -->
        <section class="order">
          <ul>
            <li><b>Order</b>
              <ol>
                <li><a href="#">Create Order</a></li>
                <li><a href="#">Get All Orders</a></li>
                <li><a href="#">Get All Users Orders</a></li>
                <li><a href="#">Get Single Order</a></li>
                <li><a href="#">Update Order</a></li>
              </ol>
            </li>
          </ul>
        </section>
        <!-- END OF ORDER SECTION -->

        <!-- BEGINNING OF PRODUCT SECTION -->
        <section class="product">
          <ul>
            <li><b>Product</b>
              <ol>
                <li><a href="#">Create Product</a></li>
                <li><a href="#">Delete Product</a></li>
                <li><a href="#">Get All Products</a></li>
                <li><a href="#">Get Single Product</a></li>
                <li><a href="#">Update Product</a></li>
                <li><a href="#">Upload Image</a></li>
              </ol>
            </li>
          </ul>
        </section>
        <!-- END OF PRODUCT SECTION -->

        <!-- BEGINNING OF REVIEW SECTION -->
        <section class="review">
          <ul>
            <li><b>Review</b>
              <ol>
                <li><a href="#">Create Review</a></li>
                <li><a href="#">Delete Review</a></li>
                <li><a href="#">Get All Reviews</a></li>
                <li><a href="#">Get single Review</a></li>
                <li><a href="#">Update Review</a></li>
              </ol>
            </li>
          </ul>
        </section>
        <!-- END OF REVIEW SECTION -->

        <!-- BEGINNING OF USER SECTION -->
        <section class="user">
          <ul>
            <li><b>User</b>
              <ol>
                <li><a href="#">Get All Users</a></li>
                <li><a href="#">Get Single User</a></li>
                <li><a href="#">Show Current User</a></li>
              </ol>
            </li>
          </ul>
        </section>
        <!-- END OF USER SECTION -->
      </div>
      <!-- END OF LINKS TO DIFFERENT SECTIONS -->
    </section>
    <!-- END OF SIDE-BAR -->

<!-- xxxxxxxxxxxxxxxxxxxxxxxxxxx========================xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx -->

    <!-- ======MAIN-CONTENT====== -->
    <section id="main-content">


      <div class="auth-3">
        <p>Auth <span class="circle">3</span></p>

        <section class="user-info">

          <!-- -====1 -->
          <div class="login-user">
            <p>+Login User <span>POST</span> <a href="#">localhost:3000/api/
              v1/auth/login</a>
            </p>
          </div>

          <!-- ====2 -->
          <div class="logout-user">
            <p>+Login User <span>GET</span> <a href="#">localhost:3000/api/
              v1/auth/logout</a>
            </p>
          </div>

          <!-- =-=-=-3==== -->
          <div class="register-user">
            <p>+Login User <span>POST</span> <a href="#">localhost:3000/api/
              v1/auth/register</a>
            </p>
          </div>

        </section>
        <!-- end of user info -->

      </div>
<!-- auth-3 end  -->


     <div class="order-5">
        <p>Order <span class="circle">5</span></p>

        <section class="order-info">

          <!-- -====1 -->
          <div class="create-order">
            <p>+Login User <span>POST</span> <a href="#">localhost:3000/api/
              v1/orders/createPaymentIntent</a>
            </p>
          </div>

          <!-- ====2 -->
          <div class="get-all-orders">
            <p>+Login User <span>GET</span> <a href="#">localhost:3000/api/
              v1/orders</a>
            </p>
          </div>

          <!-- =-=-=-3==== -->
          <div class="get-all-user-orders">
            <p>+Login User <span>GET</span> <a href="#">localhost:3000/api/
              v1/orders/showAllMyOrders</a>
            </p>
          </div>

          <!-- =-=-=-4==== -->
          <div class="get-single-order">
            <p>+Login User <span>GET</span> <a href="#">localhost:3000/api/
              v1/orders/</a>
            </p>
          </div>


          <!-- =-=-=-5==== -->
          <div class="update-order">
            <p>+Login User <span>PATCH</span> <a href="#">localhost:3000/api/
              v1/orders/</a>
            </p>
          </div>

        </section>

      </div>
      <!-- ORDER 5 ENDING ------=== -->
    <!-- END OF MAIN-CONTENT -->
  </main>

</body>
</html>