Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloud0259/ControllerGenerator
Automatic Controller Generator with Source Generator.
https://github.com/cloud0259/ControllerGenerator
api controller csharp sourcegenerator
Last synced: about 1 month ago
JSON representation
Automatic Controller Generator with Source Generator.
- Host: GitHub
- URL: https://github.com/cloud0259/ControllerGenerator
- Owner: cloud0259
- License: mit
- Created: 2023-07-17T20:05:12.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-07-29T11:19:30.000Z (over 1 year ago)
- Last Synced: 2024-10-31T20:15:30.082Z (about 1 month ago)
- Topics: api, controller, csharp, sourcegenerator
- Language: C#
- Homepage:
- Size: 52.7 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- RSCG_Examples - ControllerGenerator
- csharp-source-generators - ControllerGenerator -   Automatically generate controllers from services in a web application (Source Generators / Webprogramming)
README
# ControllerGenerator
| ControllerGenerator | ControllerGenerator.Abstraction | Action |
|------------------|------------------|------------------|
| [](https://www.nuget.org/packages/ControllerGenerator) | [](https://www.nuget.org/packages/ControllerGenerator.Abstraction) | [](https://github.com/cloud0259/ControllerGenerator/actions) |
|  |  | |
This project is an automatic controller generator for .NET projects. It uses Source Generator to automatically create controllers from specified services in a project containing the services.
## Installation
To use this generator, you need to install the ControllerGenerator.Abstractions library in the project that contains the services you want to use for generating controllers.
```
Install-Package ControllerGenerator.Abstractions
```
In your web project, it is necessary to install the ControllerGenerator library
```
Install-Package ControllerGenerator
```
## Usage
To have your services recognized by the generator, each service or its interface must inherit the IAutoGenerateController interface.
```csharp
public interface IMyService : IAutoGenerateController
{
// Service methods
}
```
## Request Generation based on Method Prefixes
Requests in the generated controllers are determined based on the method prefixes:
- If the service method starts with "Get", "Post", "Patch", "Update", "Create", or "Delete", the generated request will correspond to the respective HTTP methods.
- If there is no prefix, the generated request will be of type HTTP POST.
Attributes can be used in services. These will be recognized by the Source Generator
## Requirements
The Source Generator library must be installed in the target project. The target project should be a .NET 7.0 web application or a higher version.
### Example
Here's an example of using this generator:
```csharp
// In the project containing the services
public interface IMyService : IAutoGenerateController
{
Task GetUserAsync(int id);
Task PostUser(UserData data);
Task UpdateUser(int id, UserData data);
// Other service methods
}
//Service implementation
public class MyService : IMyService
{
//Property, Ctor ....
[HttpGet] //it's not mandatory
[Authorize("Admin")]
public async Task GetUserAsync(int id)
{
return await userList.FirstOrDefaultAsync(x => x.Id == id);
}
[NoGenerated] //This method is not generate for the controller
public Task PostUser(UserData data)
{
throw new Exception("An error has occured")
}
//Other method...
}
// In the .NET 7.0 or higher web project
// The generator will automatically create a controller for IMyService with corresponding HTTP methods for each method in the service.
public class MyController : ControllerBase
{
private readonly IMyService _myService;
public MyController(IMyService myService)
{
_myService = myService;
}
// GET endpoint generated for GetUserAsync
[HttpGet("{id}")]
public IActionResult GetUser(int id)
{
// Implementation
}
// POST endpoint generated for PostUser
[HttpPost]
public IActionResult PostUser([FromBody] UserData data)
{
// Implementation
}
// Other endpoints for UpdateUser and other service methods
}
```
It is possible to replace a controller generated by the source generator by creating a controller that inherits the interface of the service to replace
```csharp
public class MyController : ControllerBase, IMyService
{
//Implement the interface to replace the self-generated controller
}
```
## Disclaimer
This generator uses Source Generator to automatically generate controllers. Make sure you understand how it works before using it in your project. Please perform thorough testing to ensure that the generated controllers meet your requirements.
## Contributing
Contributions are welcome! Please see the CONTRIBUTING.md file for information on how to contribute to this project.
## License
This project is licensed under the MIT License.