Rest Helper
Do you want to read in Portuguese? Click here!
This Visual Studio Code extension helps developers validate RESTful routes in C# files according to specific rules. The extension reads rules from a configuration file and checks the routes in C# controllers and program files to ensure they align with defined standards. Invalid routes are highlighted, providing developers with a quick way to identify and rectify inconsistencies.
Features
- Automatic Validation: The extension automatically validates routes whenever a C# file is saved, providing real-time feedback on route quality.
- Manual Validation: Developers can manually trigger route validation using extension commands.
- Configuration File: Define custom validation rules in a JSON configuration file.
- Output Console: View validation results and error messages in the extension's output console.
Installation
- Install the extension from the Visual Studio Code Marketplace.
- Start using it.
Example rule:
{
"rules": [
{
"name": "Route Length",
"type": 1,
"rule": "3",
"message": "It is recommended that routes do not have too many parts to avoid excessive complexity."
},
// Add more rules as necessary
]
}
Usage
- Enable Automatic Execution: Use the command palette to enable automatic validation upon saving files.
- Manual Validation: Use commands in the command palette to manually validate RESTful routes in the active C# file.
Configuration
Configure your validation rules in the settings.json file in your workspace's configuration directory. Define rules with names, types, criteria, and error messages.
This file can be accessed through File > Preferences > Settings or by the shortcut Ctrl + “,”, searching for RestHelper under the Workspace tab, and clicking Edit in settings.json.
Commands
extension.enableAutoRunRestHelper: Activates automatic validation upon saving files.extension.disableAutoRunRestHelper: Disables automatic validation upon saving files.extension.validateRestfulRoutes: Manually validates RESTful routes in the active C# file.
Requirements
- This extension requires valid C# files within a Visual Studio Code workspace.
Extension Settings
- There are no specific settings required for this extension.
Known Issues
Release Notes
[0.1.2] - 12/12/2023
- Initial Beta Release of the RESTful Routes Validation Extension.
License
This extension is licensed under the MIT License.
