swagger.yaml

openapi: 3.0.0
info:
  title: TwitMaster API (Twitter-like advance Backend)
  version: 1.0.0
  description: API documentation for Twitter-like backend built with Node.js, MongoDB, JWT, and AWS S3
 
servers:
  - url: http://localhost:3000/api/v1

components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

  schemas:
    User:
      type: object
      properties:
        email:
          type: string
          format: email
        name:
          type: string
        password:
          type: string
      required:
        - email
        - name
        - password

    AuthResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          type: object
          properties:
            token:
              type: string
        error:
          type: object

    Tweet:
      type: object
      properties:
        content:
          type: string
        image:
          type: string
        likes:
          type: array
          items:
            type: string
        comment:
          type: array
          items:
            type: string

    TweetResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          $ref: '#/components/schemas/Tweet'
        error:
          type: object

paths:
  /signup:
    post:
      summary: Register new user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/User'
      responses:
        '200':
          description: User registered successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'

  /login:
    post:
      summary: Login and get JWT token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                password:
                  type: string
              required:
                - email
                - password
      responses:
        '200':
          description: Login successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'

  /tweets:
    post:
      summary: Create a new tweet
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                content:
                  type: string
                image:
                  type: string
                  format: binary
      responses:
        '200':
          description: Tweet created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TweetResponse'

    get:
      summary: Get all tweets
      responses:
        '200':
          description: List of tweets
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Tweet'
                  error:
                    type: object

  /likes/toggle:
    post:
      summary: Toggle like/unlike for a tweet or comment
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                modelId:
                  type: string
                modelType:
                  type: string
                  enum: [Tweet, Comment]
      responses:
        '200':
          description: Like toggled
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: boolean
                  error:
                    type: object

  /comment:
    post:
      summary: Create comment on tweet or comment
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                modelId:
                  type: string
                modelType:
                  type: string
                  enum: [Tweet, Comment]
                content:
                  type: string
      responses:
        '200':
          description: Comment created
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                  error:
                    type: object