Home

A boilerplate/starter project for quickly building RESTful APIs using Node.js, Express, and Mongoose.

APIs

1. User
   • Authentication API Documentation
     • Signup: POST /api/{{VERSION}}/auth/signup
     • Verify signup using email: GET /api/{{VERSION}}/auth/verify/verification-token
     • Login: POST /api/{{VERSION}}/auth/login
     • Request password reset email: PUT /api/{{VERSION}}/auth/request-new-password
     • Resend password reset email: PUT /api/{{VERSION}}/auth/resend-verification/verification-token
     • Reset password: PUT /api/{{VERSION}}/auth/reset-password/verification-token
     • Logout: GET /api/{{VERSION}}/auth/logout
   • Profile
     • Update personal information:
     • Reset password:
     • Delete account:
2. Admin API Documentation
   • Admin
     • Create admin: POST /api/{{VERSION}}/admin
     • Verify admin request using email: GET /api/{{VERSION}}/admin/verify/verification-token
     • Admin Login: /api/{{VERSION}}/admin/login
     • Request password reset email: PUT /api/{{VERSION}}/admin/request-new-password
     • Resend password reset email: GET /api/{{VERSION}}/admin/resend-verification/token-id
     • Reset password: PUT /api/{{VERSION}}/admin/reset-password/verification-token
     • Logout: GET /api/{{VERSION}}/admin/logout
   • Permissions Management API
     • Create permission: POST /api/{{VERSION}}/permissions
     • Create default permission: POST /api/{{VERSION}}/permissions/default
     • Get all permissions: GET /api/{{VERSION}}/permissions
     • Get permission by ID: GET /api/{{VERSION}}/permissions/permission-id
     • Update permission by ID: PUT /api/{{VERSION}}/permissions/permission-id
     • Delete permission by ID: DELETE /api/{{VERSION}}/permissions/permission-id
     • Delete permission by list: DELETE /api/{{VERSION}}/permissions?ids=permission-id1,permission-id2
   • Role Management API
     • Create role: POST /api/{{VERSION}}/roles
     • Create default role: POST /api/{{VERSION}}/roles/default
     • Get all roles: GET /api/{{VERSION}}/roles
     • Get role by ID: GET /api/{{VERSION}}/roles/role-id
     • Update role by ID: PUT /api/{{VERSION}}/roles/role-id
     • Delete role by ID: DELETE /api/{{VERSION}}/roles/role-id
     • Delete role by list: DELETE /api/{{VERSION}}/roles?ids=role-id1,role-id2
3. Public
   • Detect
     • User device detection