https://github.com/interappconnectorproject/interappconnector
Library that helps to create modules that can be easily integrated in different project types
https://github.com/interappconnectorproject/interappconnector
dotnet library modular-programming module module-pattern
Last synced: 20 days ago
JSON representation
Library that helps to create modules that can be easily integrated in different project types
- Host: GitHub
- URL: https://github.com/interappconnectorproject/interappconnector
- Owner: interappconnectorproject
- License: mit
- Created: 2023-11-17T10:33:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-14T10:56:11.000Z (about 1 year ago)
- Last Synced: 2025-09-30T19:29:59.820Z (4 months ago)
- Topics: dotnet, library, modular-programming, module, module-pattern
- Language: C#
- Homepage:
- Size: 180 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://sonarcloud.io/summary/new_code?id=interappconnectorproject_interappconnector)
[](https://sonarcloud.io/summary/new_code?id=interappconnectorproject_interappconnector)
[](https://sonarcloud.io/summary/new_code?id=interappconnectorproject_interappconnector)
[](https://sonarcloud.io/summary/new_code?id=interappconnectorproject_interappconnector)
[](https://sonarcloud.io/summary/new_code?id=interappconnectorproject_interappconnector)
[](https://sonarcloud.io/summary/new_code?id=interappconnectorproject_interappconnector)
# InterAppConnector
InterAppConnector is a library that helps to create modules that can be easily integrated in different applications and project types by using a common message format.
It is very useful for software or applications that are developed using the modular programming and in particular the module pattern.
You can create one or more modules (called commands) and call them in the same mode without worrying about the project type
# Features
- Easy integration and out-of-box experience with console applications
- Integration with web applications, automated and non-interactive procedures (such as batch, jobs, automated tasks, ...) and other project types
- Argument definition in classes. You can define mandatory and optional arguments that are checked before the command starts
- Extensible
- Support for obfuscated code (in preview)
# Quick example
1. Create a class for parameters and name it `SampleArgument`. Add a string property called `Name`
```csharp
public class SampleArgument
{
public string Name {get; set;} = string.Empty;
}
```
2. Create a class for command and name it `SampleCommand`
1. Add a `Command` attribute and implement `ICommand` interface
2. In `Main` method write your business logic code
```csharp
[Command("hello", Description = "A simple hello command")]
public class SampleCommand : ICommand
{
public string Main(SampleArgument command)
{
return CommandOutput.Ok("Hello, " + command.Name);
}
}
```
3. Depending on your project type:
- In a console application, add in your `Program.cs` file in `Main(string[] args)` this code
```csharp
CommandManager command = new CommandManager();
command.AddCommand();
InterAppCommunication connector = new InterAppCommunication(command);
connector.ExecuteAsInteractiveCLI(args);
```
- In other applications:
- Parameters must be defined in a `dynamic` object where the name of the properties are the name of the arguments
- Replace `ExecuteAsInteractiveCLI(string[])` method of the example above with `ExecuteAsBatch(string, dynamic)` method
```csharp
dynamic arguments = new ExpandoObject();
arguments.Name = "John";
CommandManager command = new CommandManager();
command.AddCommand();
InterAppCommunication connector = new InterAppCommunication(command);
CommandResult result = connector.ExecuteAsBatch("hello", arguments);
```
4. Build the project if you have created a console application, otherwise go to step 5
5. In order to get the result
- If you are creating a console application, open the Command Prompt in Windows or Bash in Linux and type the command below (it is assumed that the project name is called SampleProgram)
```batch
SampleProgram.exe hello -name John
```
You will see a green message with the date and time in current datetime format, the message status followed by the success code and the message `Hello, John`. A typical execution of the program generate the following output:
`[11/10/2023 23:50:34] SUCCESS (0): Hello, John`
- In other applications, use the object returned by the `ExecuteAsBatch` method.
# Documentation and code examples
For advanced scenarios and in order to learn how to use the library efficiently, see the documentation provided with the library. Below you will find informations about how to find this documentation
## General documentation
The general documentation is available in the [GitHub Wiki](https://github.com/interappconnectorproject/interappconnector/wiki) section.
## Code examples
The [InterAppConnector sample code repository](https://github.com/interappconnectorproject/interappconnector-samples) contains code examples that shows how to use the library