README.md 934 B

forum-backend

This is the backend (or 'api component') of the forum software to go along with the corresponding frontend project.

API Documentation

All API routes are prefixed /api/v1/

/admin_token

/

  • Method: POST
  • Response: { id: <integer>, token: <string> }
  • Notes: requires admin privileges

/ban

/

  • Method: GET
  • Data params:
    • message
    • username:
    • canCreateThreads
    • canCreatePosts
    • ipBanned
    • Response: { id: <integer>, message: <string>, canCreateThreads: <boolean>, canCreatePosts: <boolean>, ipBanned: <boolean>, User: { id: <integer>, username: <string>, description: <null | string>, color: <string>, createdAt: <string> }
      • Notes: requires admin privileges