hectormalvarez / ticketsys-api

Ticketing System API

Note: Documentation Still In Progress...

This is an API for a ticketing system that allows users to create, view, and manage tickets.

Technologies Used

• Node.js
• TypeScript
• Express
• MySQL
• Sequelize
• sequelize-typescript
• bcrypt
• crypto
• jsonwebtoken
• passport
• passport-jwt

Installation

To run this API on your local machine, you will need to have Node.js and MySQL installed. Once you have these installed, follow these steps:

1. Clone this repository to your local machine.

2. Open a terminal and navigate to the project directory.

3. Run npm install to install the required dependencies.

4. Set up your environment variables. Create a dbConfig.ts file in the src/config directory of the project and add the following code:

   var dbConfig = {
     HOST: 'localhost',
     USER: 'root',
     PASSWORD: '[password]',
     DB: '[Database Name]',
     DIALECT: 'mysql',
   
     pool: {
       max: 5,
       min: 0,
       aquire: 30000,
       idle: 10000
     }
   };
   
   export default dbConfig;

5. Run npm start to start the server.

6. The API will now be available at http://localhost:8080.

Features

The following features are available:

GET /tickets/filter

Get a list of tickets.

GET /tickets/filter Query parameters

• status: Filter by ticket status (optional). Possible values: open, closed.
• priority: Filter by ticket priority (optional). Possible values: low, medium, high.

GET /tickets/:id

Get the details of a specific ticket.

GET /tickets/:id Path parameters

• id: The ID of the ticket.

POST /tickets

Create a new ticket.

POST /tickets Request body

• title: The title of the ticket.
• description: The description of the ticket.
• priority: The priority of the ticket. Possible values: low, medium, high.
• status: The status of the ticket. Possible values: open, closed.

PUT /tickets/:id

Update the status or priority of a ticket.

PUT /tickets/:id Path parameters

• id: The ID of the ticket.

PUT /tickets/:id Request body

• priority (optional): The new priority of the ticket. Possible values: low, medium, high.
• status (optional): The new status of the ticket. Possible values: open, closed.

DELETE /tickets/:id

Delete a ticket.

DELETE /tickets/:id Path parameters

• id: The ID of the ticket.

Error Handling

This API uses standard HTTP status codes to indicate success or failure of requests. In case of an error, a JSON response with the following format will be returned:

{
  "error": {
    "code": <HTTP status code>,
    "message": "<error message>"
  }
}

Testing

This API uses Jest for testing. To run the tests, run npm test in the terminal.

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue on this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.