Backend - Server-Management-Funktionen

[max5800]

Server Management Features ToDo List for beammp-server-mgmt

Tasks Overview

• [x] Define Requirements

  • Outline specific server management functionalities to implement.
  • Clarify use cases and user interactions.

• [ ] Design API Endpoints

  • Plan and define the necessary API routes for server management.
  • Determine input parameters needed from users.

• [ ] Implement Backend Logic

  • Develop the logic to interact with the BeamMP server.
  • Ensure robust error handling and provide useful feedback.

• [ ] Ensure Security and Access Control

  • Implement authentication checks to restrict access to authorized users.
  • Validate all inputs for security and integrity.

• [ ] Testing

  • Write unit tests for each function to validate its operation.
  • Perform integration testing to ensure the API works as expected.

• [ ] Documentation

  • Document the API endpoints for clear understanding and future reference.

• [ ] Frontend Integration (if applicable)

  • Develop user interfaces for interacting with these backend features.
  • Ensure proper communication between frontend and backend.

• [ ] Gather Feedback and Adjust

  • Obtain user feedback for the initial functionalities.
  • Be prepared to adjust or extend the features based on feedback and testing.

Detailed Breakdown

Define Requirements

• [ ] List specific server actions (start, stop, restart, status check, etc.).
• [ ] Determine the necessary inputs for each action.

Design API Endpoints

• [x] Create route structure (e.g., POST /api/server/start).
• [ ] Define required parameters and expected responses.

Implement Backend Logic

• [ ] Develop code to send commands to the server process.
• [ ] Implement error handling for each server action.

Ensure Security and Access Control

• [ ] Add authentication checks on each server management endpoint.
• [ ] Validate inputs to prevent common web vulnerabilities.

Testing

• [ ] Create unit tests for individual functions.
• [ ] Use tools like Postman for endpoint testing.

Documentation

• [ ] Write clear documentation for each API endpoint.
• [ ] Include examples and usage guidelines.

Frontend Integration

• [ ] (Optional) Design UI components for server management.
• [ ] (Optional) Implement API calls from the frontend to the backend.

Gather Feedback and Adjust

• [ ] Collect initial user feedback on functionality.
• [ ] Refine and improve features based on feedback and test results.

[max5800]

Server Actions to implement

• [x] add command: start
• [x] add command: stop
• [ ] add command: restart / reload (optional)

[max5800]

Server Command Routes work, need to compile beammp to further test.

[max5800]

config-editor route implemented, but not tested. Next Step, editor route testing.

[max5800]

Das testen der Route hat funktioniert, aber ich habe festgestellt, dass eine authentifizierung für das benutzen der api implementiert werden muss. Dafür werde ich jwt (json web token) verwenden. Das plugin ist schon installiert (npm install jsonwebtoken). Dafür muss die auth-route.js um jwt erweitert werden und eine middleware erstellt und in den server.js eingebaut werden. Bis dahin werde ich mich aber auf die Implementierung der restlichen Backend-Funktionen konzentrieren.