RestApiGenerator.Core
1.0.1
See the version list below for details.
dotnet add package RestApiGenerator.Core --version 1.0.1
NuGet\Install-Package RestApiGenerator.Core -Version 1.0.1
<PackageReference Include="RestApiGenerator.Core" Version="1.0.1" />
<PackageVersion Include="RestApiGenerator.Core" Version="1.0.1" />
<PackageReference Include="RestApiGenerator.Core" />
paket add RestApiGenerator.Core --version 1.0.1
#r "nuget: RestApiGenerator.Core, 1.0.1"
#:package RestApiGenerator.Core@1.0.1
#addin nuget:?package=RestApiGenerator.Core&version=1.0.1
#tool nuget:?package=RestApiGenerator.Core&version=1.0.1
RestApiGenerator
This project aims to provide a robust and flexible solution for generating REST API client code from Swagger/OpenAPI specifications. It is designed to be easily extensible and integrateable into various development workflows.
RestApiGenerator.Core
The RestApiGenerator.Core library is the core component of this project, offering functionalities for:
- Parsing Swagger/OpenAPI specifications (JSON/YAML).
- Converting API schemas into structured, language-agnostic code models.
- Generating client code in various programming languages (currently C# is fully supported).
- Providing extensibility points for custom code generation logic and plugin integration.
Installation
You can install RestApiGenerator.Core via NuGet Package Manager. Once published, you can use the following command:
dotnet add package RestApiGenerator.Core
Usage
To use RestApiGenerator.Core programmatically in your .NET project:
- Add the NuGet package to your project.
- Instantiate the parser and generator:
RestApiGenerator.CLI
The RestApiGenerator.CLI project provides a command-line interface for easy interaction with the core library. This is ideal for quick code generation or integration into build scripts without requiring programmatic setup.
Installation
(Once the CLI tool is packaged as a .NET tool, installation instructions will be provided here, e.g., dotnet tool install --global RestApiGenerator.CLI).
Usage
(Detailed CLI usage examples will be added here, e.g., restapigenerator generate --input swagger.json --output ./GeneratedClient --lang CSharp --namespace MyApiClient).
Contributing
We welcome contributions to the RestApiGenerator project! If you'd like to contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and ensure tests pass.
- Submit a pull request with a clear description of your changes.
Please ensure your code adheres to the existing coding style and includes appropriate tests.
License
This project is licensed under the MIT License. See the LICENSE file in the root of the repository for more details.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net8.0
- Microsoft.CodeAnalysis.CSharp (>= 4.14.0)
- Newtonsoft.Json (>= 13.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.