search-management-api

Description

This repository contains a Web API solution with Swagger documentation and a separate test solution for testing the API.

Swagger Documentation

The API is Swagger-enabled, which means you can explore and test the API endpoints using Swagger UI. To access the Swagger documentation, follow these steps:

1. After running the project locally (see the next section for instructions), open a web browser.

2. Navigate to the following URL: http://localhost:PORT/swagger Replace PORT with the port number where the API is running.

3. You will be presented with the Swagger UI, where you can browse and test the available API endpoints.

Running the Project Locally

To run the project locally, follow these steps:

1. Clone or download this repository to your local machine.

2. Open Visual Studio. Open 'search-management-api' Folder

3. In Visual Studio, select the "SearchManagement.API" folder from the folder view in Solution Explorer.

4. Open the "SearchManagement.sln" solution file located in the "SearchManagement.API" folder.

5. Build and run the project. The API should start locally, and you can access it at http://localhost:PORT, where PORT is the port number specified in the project configuration.

Running Tests

To run the test cases for the API, follow these steps:

1. After opening the project in Visual Studio, click on the "Test" menu in the top menu bar.

2. Select "Test Explorer" from the dropdown.

3. In the Test Explorer window, click on the "Run All Tests" button.

4. The test cases will be executed, and the results will be displayed in the Test Explorer.

Feel free to explore and use the API, and don't hesitate to reach out if you have any questions or issues.