Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ignatandrei/webapi2cli
Execute ASP.NET Core WebAPI from Command Line
https://github.com/ignatandrei/webapi2cli
asp-net-core cli csharp visual-studio webapi
Last synced: about 2 months ago
JSON representation
Execute ASP.NET Core WebAPI from Command Line
- Host: GitHub
- URL: https://github.com/ignatandrei/webapi2cli
- Owner: ignatandrei
- License: mit
- Created: 2020-03-04T23:26:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-17T07:44:31.000Z (almost 4 years ago)
- Last Synced: 2024-04-15T03:09:44.049Z (10 months ago)
- Topics: asp-net-core, cli, csharp, visual-studio, webapi
- Language: C#
- Homepage: https://ignatandrei.github.io/WebAPI2CLI/
- Size: 40.4 MB
- Stars: 29
- Watchers: 3
- Forks: 5
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WebAPI2CLI
Execute ASP.NET Core WebAPI from Command Line . Source at https://github.com/ignatandrei/WebAPI2CLI
[](https://github.com/ignatandrei/WebAPI2CLI/blob/master/LICENSE)
[](https://www.nuget.org/packages/ExtensionNetCore3)
[](https://dev.azure.com/ignatandrei0674/WebAPI2CLI/_build/latest?definitionId=7&branchName=master)
# Why
What if, instead of running the WebAPI ( or just the site ) and waiting for commands from the user, you want also to execute from the command line some controllers actions ?
This project let's you do that by enabling the command line with
< myexe >.exe --CLI_ENABLED=1 --CLI_Commands=" ... "
The command names are in a *cli.txt* file that can be generated with
< myexe >.exe --CLI_ENABLED=1 --CLI_HELP=1
# How to use ( for .NET Core 3.1 )
## Step 0 : install into your ASP.NET Core Web
Install the package https://www.nuget.org/packages/ExtensionNetCore3
Modify your ASP.NET Core as below:
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddCLI();
//your code omitted
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
app.UseCLI();
//your code omitted
}
```
And that is all modifications that you need to do for the source code.
## Step 1 - find and save the definition of the commands, i.e. WebAPI endpoints
First, you must generate the definition of the commands. For this, we take the OPEN API (swagger ) approach.
For this, after you compile the project, you will run your .exe program with arguments:
< myexe >.exe --CLI_ENABLED=1 --CLI_HELP=1
( or make this from *Visual Studio, Project, Properties, Debug* )
This will generate a *cli.txt* file with all definitions of the WebAPI.
( if your API does not appear, check if you have *ApiController* defined)
Open your *cli.txt* file and modify the names of the commands as you wish (also , the arguments )
Copy this *cli.txt* in your solution and be sure that is copied with the exe ( in Visual Studio right click the file, properties, Build Action = Content, CopyToOutputDirectory = Copy if newer)
## Step 2 - run the commands
Ensure that the file is near your exe WebAPI.
Run the exe with the following:
< myexe >.exe --CLI_ENABLED=1 --CLI_Commands="your first command,your second command, and enumerate all commands"
The program will run the commands and output the result.
## Optional Step 3 - letting others download the app to use as CLI
Modify the endpoints to add zip
```csharp
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
endpoints.MakeZip(app);
});
```
and browser to /zip to download the whole application.
More details here( including a demo)
https://ignatandrei.github.io/WebAPI2CLI/
Environment Variables: see https://github.com/ignatandrei/Interpreter