Draft
Conversation
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: ramesh2051 <95218310+ramesh2051@users.noreply.github.com>
Co-authored-by: ramesh2051 <95218310+ramesh2051@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add API endpoint guide to home page
Add API endpoint guide to Home page
Feb 3, 2026
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+119
to
+133
| <div class="col-lg-6"> | ||
| <div class="card border-0 shadow-sm h-100 bg-light"> | ||
| <div class="card-body d-flex flex-column justify-content-center text-center p-5"> | ||
| <i class="bi bi-play-circle-fill display-1 text-primary mb-4"></i> | ||
| <h4 class="mb-3">Interactive API Testing</h4> | ||
| <p class="text-muted mb-4"> | ||
| 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. | ||
| </p> | ||
| <a href="/swagger" class="btn btn-primary btn-lg"> | ||
| <i class="bi bi-box-arrow-up-right"></i> Open Swagger UI | ||
| </a> | ||
| </div> | ||
| </div> | ||
| </div> |
There was a problem hiding this comment.
The Swagger UI link will not function in production environments since Swagger is only enabled when the application runs in Development mode (as configured in Program.cs lines 12-16). When users click this button in production, they will encounter a 404 error. Consider either:
- Adding conditional rendering to show this card only in Development environments using @if (Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") == "Development")
- Adding a note in the card explaining that Swagger is only available in development environments
- Configuring Swagger to be available in all environments (though this may have security implications)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds developer-facing API documentation directly on the home page to improve API discoverability.
Changes
/api/ShipAgenciesApiendpoint with method, path, and JSON response exampleInstead of hardcoded
http://localhost:5145/api/Screenshot
The guide section appears below the module cards on the home page, styled with Bootstrap 5 cards for visual consistency.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.