Merge branch 'swaggerDocWithChanges' into 'main'

docs

See merge request !43

app/(apidocs)/apidocs/page.tsx

+import { getApiDocs } from '@/lib/swagger'
+import ReactSwagger from './react-swagger'
+
+export default async function IndexPage() {
+    const spec = await getApiDocs()
+    return (
+        <section className="container">
+            <ReactSwagger spec={spec} />
+        </section>
+    )
+}
\ No newline at end of file

app/(apidocs)/apidocs/react-swagger.tsx

+'use client'
+
+import SwaggerUI from 'swagger-ui-react'
+import 'swagger-ui-react/swagger-ui.css'
+
+type Props = {
+    spec: Record<string, any>,
+}
+
+function ReactSwagger({ spec }: Props) {
+    return <SwaggerUI spec={spec} />
+}
+
+export default ReactSwagger
\ No newline at end of file

app/api/games/route.ts

@@ -5,6 +5,21 @@ import { IPlatformCategrory } from "@/types/igdb-types"
 
 import { NextRequest, NextResponse } from "next/server"
 
+/**
+ * @swagger
+ * /api/games:
+ *   get:
+ *     description: Get Games through external API
+ *     content:
+ *      application/json:
+ *          schema:
+ *     responses:
+ *       200:
+ *         description: list of games
+ *       500:
+ *         description: error
+ */
+
 export async function GET(req: NextRequest) {
     const p = req.nextUrl.searchParams
     try {

app/api/gweets/[id]/route.ts

@@ -3,6 +3,33 @@ import { z } from "zod"
 
 import { db } from "@/lib/db"
 
+/**
+ * @swagger
+ * /api/gweets/{id}:
+ *   get:
+ *     description: Gives back a List of Gweets
+ *     parameters:
+ *       - name: id
+ *         in: path
+ *         description: ID of Gweet that needs to be fetched
+ *         required: true
+ *         schema:
+ *           type: integer
+ *           format: int64
+ *     content:
+ *      application/json:
+ *          schema:
+ *     responses:
+ *       200:
+ *         description: fetched gweets!
+ *       400:
+ *         description: Invalid request body!
+ *       404:
+ *         description: Gweet not found!
+ *       500:
+ *         description: Error
+ */
+
 export async function GET(request: Request, { params }: { params: { id: string } }) {
     const { id } = params
 

app/api/gweets/likes/route.ts

@@ -3,6 +3,36 @@ import { z } from "zod"
 
 import { db } from "@/lib/db"
 
+/**
+ * @swagger
+ * /api/gweets/likes:
+ *   get:
+ *     description: Gets back likeData
+ *     content:
+ *      application/json:
+ *          schema:
+ *     responses:
+ *       200:
+ *         description: fetched like!
+ *       500:
+ *         description: Error
+ *
+ *   post:
+ *     description: Creates Gweet
+ *     responses:
+ *       200:
+ *         description: Gweet unliked!
+ *       201:
+ *         description: Gweet liked!
+ *       401:
+ *         description: Unauthorized
+ *       404:
+ *         description: Invalid request body !
+ *       500:
+ *         description: Error
+ *
+ */
+
 export async function GET(request: Request) {
     const { searchParams } = new URL(request.url)
     const user_id = searchParams.get("user_id") || undefined

app/api/gweets/regweets/route.ts

@@ -3,6 +3,24 @@ import { z } from "zod"
 
 import { db } from "@/lib/db"
 
+/**
+ * @swagger
+ * /api/gweets/regweets:
+ *   post:
+ *     description: Creates Regweet
+ *     responses:
+ *       200:
+ *         description: Deleted gweet regweet!
+ *       201:
+ *         description: Gweet regweeted!
+ *       400:
+ *         description: Invalid request body
+ *       401:
+ *         description: Unauthorized
+ *       500:
+ *         description: Error
+ */
+
 export async function POST(request: Request) {
     const { gweet_id, user_id } = await request.json()
 

app/api/gweets/route.ts

@@ -4,6 +4,41 @@ import { z } from "zod"
 import { db } from "@/lib/db"
 import { utapi } from "uploadthing/server"
 
+/**
+ * @swagger
+ * /api/gweets:
+ *   get:
+ *     description: Gives back a List of Gweets
+ *     content:
+ *      application/json:
+ *          schema:
+ *     responses:
+ *       200:
+ *         description: fetched gweets!
+ *       500:
+ *         description: Error
+ *
+ *   post:
+ *     description: Creates Gweet
+ *     responses:
+ *       200:
+ *         description: Gweet created!
+ *       401:
+ *         description: Unauthorized
+ *       500:
+ *         description: Error
+ *
+ *   delete:
+ *     description: Deletes Gweet
+ *     responses:
+ *       200:
+ *         description: deleted!
+ *       401:
+ *         description: Unauthorized
+ *       500:
+ *         description: Error
+ */
+
 export async function GET(request: Request) {
     const { searchParams } = new URL(request.url)
 

app/api/hashtags/route.ts

@@ -3,6 +3,32 @@ import { z } from "zod"
 
 import { db } from "@/lib/db"
 
+/**
+ * @swagger
+ * /api/hashtags:
+ *   get:
+ *     description: Gives back a List of Hashtags
+ *     content:
+ *      application/json:
+ *          schema:
+ *     responses:
+ *       200:
+ *         description: fetched hashtags!
+ *       500:
+ *         description: Error
+ *
+ *   post:
+ *     description: Creates Hashtag
+ *     responses:
+ *       200:
+ *         description: Hashtag created!
+ *       401:
+ *         description: Unauthorized
+ *       500:
+ *         description: Error
+ *
+ */
+
 export async function GET() {
     try {
         const hashtags = await db.hashtag.findMany({

app/api/signup/route.ts

@@ -3,6 +3,22 @@ import { hash } from 'bcrypt'
 import { NextResponse } from 'next/server'
 import { normalize } from 'normalize-diacritics'
 
+/**
+ * @swagger
+ * /api/signup:
+ *
+ *   post:
+ *     description: Creates Account after Email was verified
+ *     responses:
+ *       200:
+ *         description: Verification sent!
+ *       422:
+ *         description: Email already used
+ *       500:
+ *         description: Error!
+ *
+ */
+
 export async function POST(req: Request) {
     try {
         const { username, email, password } = await req.json()

app/api/users/follow/route.ts

@@ -3,6 +3,42 @@ import { getCurrentUser } from "@/lib/session"
 import { NextResponse } from "next/server"
 import { z } from "zod"
 
+/**
+ * @swagger
+ * /api/users/follow:
+ *   get:
+ *     description: Get Followers for signed in User
+ *     responses:
+ *       200:
+ *         description: fetched follows!
+ *       500:
+ *          description: Error
+ *
+ *   put:
+ *     description: Creates Following Record from one User to another
+ *     requestBody:
+ *        content:
+ *         application/json:
+ *           schema:      # Request body contents
+ *             type: object
+ *             properties:
+ *               follwerid:
+ *                 type: string
+ *               followingid:
+ *                 type: string
+ *             example:   # Sample object
+ *               follwerid:: 10
+ *               followingid:: 12
+ *     responses:
+ *       200:
+ *         description: Follow handled!
+ *       401:
+ *         description: Unauthorized
+ *       500:
+ *          description: Error
+ *
+ */
+
 export async function GET(request: Request) {
     const { searchParams } = new URL(request.url)
     const username = searchParams.get("userId") || undefined

app/api/users/gamelists/route.ts

@@ -4,6 +4,20 @@ import { User } from "@prisma/client"
 import { revalidatePath } from "next/cache"
 import { NextRequest, NextResponse } from "next/server"
 
+/**
+ * @swagger
+ * /api/users/gamelists:
+ *   put:
+ *     description: Changes gamelists of a user
+ *                 id in body must match userid
+ *     responses:
+ *       200:
+ *         description: Request handled!
+ *       401:
+ *         description: Unauthorized
+ *
+ */
+
 export async function PUT(req: NextRequest) {
     const sessionUser = await getCurrentUser()
 

lib/swagger.ts

+import { createSwaggerSpec } from 'next-swagger-doc'
+
+export const getApiDocs = async () => {
+    const spec = createSwaggerSpec({
+        apiFolder: 'app/api', // define api folder under app folder
+        definition: {
+            openapi: '3.0.0',
+            info: {
+                title: 'GameUnity Api Documentation',
+                version: '1.0',
+            },
+            components: {
+                securitySchemes: {
+                    BearerAuth: {
+                        type: 'http',
+                        scheme: 'bearer',
+                        bearerFormat: 'JWT',
+                    },
+                },
+            },
+            security: [],
+        },
+    })
+    return spec
+}
\ No newline at end of file

package.json

@@ -40,6 +40,7 @@
         "lucide-react": "^0.259.0",
         "next": "^13.4.9",
         "next-auth": "^4.22.1",
+        "next-swagger-doc": "^0.4.0",
         "next-themes": "^0.2.1",
         "normalize-diacritics": "^4.0.0",
         "react": "18.2.0",
@@ -48,6 +49,7 @@
         "react-hook-form": "^7.45.1",
         "react-infinite-scroll-component": "^6.1.0",
         "react-intersection-observer": "^9.5.2",
+        "swagger-ui-react": "^5.1.0",
         "tailwind-merge": "^1.13.2",
         "tailwindcss-animate": "^1.0.6",
         "uploadthing": "^5.1.0",
@@ -62,6 +64,7 @@
         "@types/node": "^20.4.0",
         "@types/react": "^18.2.14",
         "@types/react-dom": "^18.2.6",
+        "@types/swagger-ui-react": "^4.18.0",
         "autoprefixer": "10.4.14",
         "eslint": "^8.44.0",
         "eslint-config-next": "^13.4.9",