Skip to content

Latest commit

 

History

History
105 lines (85 loc) · 2.12 KB

README.md

File metadata and controls

105 lines (85 loc) · 2.12 KB
Raw

Node.js CRUD API with SQLite

This project is a CRUD API built with Node.js and SQLite. It manages Authors and Books, providing endpoints to create, read, update, and delete records. Unit tests are included using Jest.

Table of Contents

Installation

  1. Clone the repository: 
    git clone https://github.com/ErickGBR/tecnical-test-node.git
  2. Navigate to the project directory: 
    cd tecnical-test-node
  3. Install the dependencies: 
    npm install

Usage

  1. Start the server: 
    npm run serve
    The server will start on http://localhost:3000.

API Endpoints

Database

  • GET /api/v1/db/: Retrieve the route to create database tables

Authors

  • GET /authors: Get all authors
  • GET /authors/:id: Get a single author by ID
  • POST /authors: Create a new author
    • Request body: 
      {
  "name": "<STRING>",
  "bio": "<STRING>"
}
  • PUT /authors/:id: Update an author by ID
    • Request body: 
      {
  "name": "<STRING>",
  "bio": "<STRING>"
}
  • DELETE /authors/:id: Delete an author by ID

Books

  • GET /books: Get all books
  • GET /books/:id: Get a single book by ID
  • POST /books: Create a new book
    • Request body: 
      {
  "title": "<STRING>",
  "summary": "<STRING>",
  "authId": <INTEGER>
}
  • PUT /books/:id: Update a book by ID
    • Request body: 
      {
  "title": "<STRING>",
  "summary": "<STRING>",
  "authId": <INTEGER>
}
  • DELETE /books/:id: Delete a book by ID

Running Tests

  1. Run the tests with Jest: 
    npm test

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

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