diff --git a/Views/Home/Index.cshtml b/Views/Home/Index.cshtml index e476e3b..c218667 100644 --- a/Views/Home/Index.cshtml +++ b/Views/Home/Index.cshtml @@ -66,6 +66,112 @@ + +
+
+
+

+ API Endpoint Guide +

+

+ Access our RESTful APIs for programmatic integration with the Ship Services platform. +

+
+
+ + +
+ +
+
+
+
Ship Agencies API
+
+
+
+ GET + /api/ShipAgenciesApi +
+

Retrieve all ship agencies with their contact information and details.

+ +
+ Response Example: + 
[
+  {
+    "id": 1,
+    "agencyName": "Blue Ocean Maritime",
+    "contactPerson": "Alice Dsouza",
+    "contactEmail": "alice@blueocean.com"
+  },
+  {
+    "id": 2,
+    "agencyName": "Global Ports",
+    "contactPerson": "John Lee",
+    "contactEmail": "john@globalports.com"
+  }
+]
+
+
+
+
+ + +
+
+
+ +

Interactive API Testing

+

+ Try out all available APIs directly in your browser with our Swagger UI interface. + Test endpoints, view request/response formats, and explore the complete API documentation. +

+ + Open Swagger UI + +
+
+
+
+ + +
+
+
+
+
Quick Start Guide
+
+
+
1. Base URL
+

+ All API endpoints are accessible at:
+ @Context.Request.Scheme://@Context.Request.Host/api/ +

+
+
+
2. Response Format
+

+ All responses are returned in JSON format with appropriate HTTP status codes. +

+
+
+
3. Testing
+

+ Use tools like curl, Postman, or our built-in Swagger UI to test the endpoints. +

+
+
+ + +
+
Example cURL Command:
+ 
curl -X GET "@Context.Request.Scheme://@Context.Request.Host/api/ShipAgenciesApi" -H "accept: application/json"
+
+
+
+
+
+
+