Enhance API Documentation and Improve Method Encapsulation #3
Conversation
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
The target framework of the 'AuthorizationServer' project has been updated from 'netcoreapp2.0' to 'net8.0'. As a part of this update, several unnecessary package references have been removed and the 'Authlete.Authlete' package has been upgraded to version '1.5.0'. Additionally, 'ImplicitUsings' and 'Nullable' were also enabled.
The commit introduces Microsoft.Extensions.Hosting library into the AuthorizationServer's Startup.cs. It also replaces services.AddMvc().AddWebApiConventions() with services.AddControllers() and modifies the Configure method to accommodate these changes. Lastly, it updates the application's routing to use app.UseRouting() and configures endpoints specifically for controllers.
…vels This commit introduces Swagger to enhance the API documentation and testing capabilities of the project. It also configures the generation of an XML comment file, offering detailed insights into the API endpoints. The Swagger UI is now accessible from the application's root URL. Additionally, access levels for certain methods within the BaseController class have been changed from public to protected to improve encapsulation. This adjustment ensures better method management in Swagger, allowing protected methods to be handled appropriately without requiring REST attributes.
…onventions` method, previously added by `WebApiCompatShim`, has been removed.
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.
Overview
This PR integrates Swagger into our project to significantly enhance our API documentation and testing capabilities. It aims to provide a more comprehensive and accessible way for developers to understand and interact with our API.
Key Changes