ZeyadTarekk/Books-API

📝 Table of Contents

• About
• API Endpoint
• Get started
  • Installation
  • Running
• Technology
• Contributors
• License

📙 About

• A simple books api to get familiar with Swagger to document api.

🔚 API Endpoints

• GET /books/
• GET /books/:book_id
• POST /books/
• DELETE /books/:book_id

🏁 Getting Started

This is an list of needed instructions to set up your project locally, to get a local copy up and running follow these instructuins.

Installation

1. Clone the repository

$ git clone https://github.com/ZeyadTarekk/Books-API.git

2. Navigate to repository directory

$ cd Books-API

3. Install dependencies

npm install

Running

1. Running on development mode

npm run start

💻 Built Using

• Node.js
• Express.js

Contributors

Zeyad Tarek

License

This software is licensed under MIT License, See License for more information ©ZeyadTarekk.