nandishns / api-authorisation-testing

README.md for Flask Library API

Below is a README file for your Flask Library API project, which includes instructions on installation and how to run the application.

---

Flask Library API

A simple Flask-based Library API demonstrating user authentication, permissions, and CRUD operations on a book database.

Installation

Follow these steps to install the required packages and set up the application:

Step 1: Clone the Repository

Clone the repository to your local machine (or download the source code).

Step 2: Install Dependencies

Navigate to the project directory and install the required packages using:

pip install -r requirements.txt

Running the Application

To run the Flask application, execute the following command in your terminal:

python app.py

The API will be available at http://localhost:5000. You can use Swagger UI to interact with the API by navigating to this URL in your web browser.

API Endpoints

• /books: Perform CRUD operations on books.
• /book/<book_id>: Retrieve, update, or delete a specific book by ID.
• /generate_token: Generate an authentication token.

To interact with most of the endpoints, an authentication token is required. Use the /generate_token endpoint to generate a token.

---

Note: Ensure to replace "app.py" with the actual name of your main Python file if it's different. This README assumes the Flask app is contained within a file named app.py.