apache / shenyu-client-dotnet

Apache ShenYu Client SDK for donet.

ShenYu .NET client

ShenYu .NET client can help you register your ASP.NET Core applications into ShenYu, similar with Java client. It supports below registration type,

• http registration
• zookeeper registration
• nacos registration
• consul registration
• etcd registration

Getting Started

Please visit related document to start to start.

For http registration, please visit HTTP Registration.

For zookeeper registration, please visit Zookeeper Registration.

For consul registration, please visit Consul Registration.

For nacos registration, please visit Nacos Registration.

For etcd registration, please visit Etcd Registration.

Attributes

You can use ShenyuClient attribute to register your APIs.

e.g. add ShenyuClient attribute in class as route prefix.

[ShenyuClient("/test/**")]
public class TestController {
  ...
}

e.g. add ShenyuClient attribute in method as route path. The final route path will be /test/hello for this endpoint.

[ShenyuClient("/test")]
public class TestController {
    [ShenyuClient("hello")]
    public IEnumerable<WeatherForecast> GetTest()
    {
        ...
    }
    ...
}

shenyu-client-dotnet's Issues

[Task] Support registration by Etcd

Description

Support registration by Etcd

Task List

No response

[Task] Add source code repository in project file

Description

After this change, when publish to central repository (nuget), the source repository can showed in the package information list.
e.g. https://www.nuget.org/packages/HG.Test/0.0.1-ultra

Task List

No response

[Task] Support register via Zookeeper

Description

like HTTP, support register by zookeeper.

Task List

1. support register uri.
2. support register metadata.

[Task] Support integration test for dotnet client

Description

Support integration test for dotnet client

Task List

No response

[Task] Support register by Nacos for dotnet client

Description

Support register by Nacos for dotnet client

Task List

No response

[Task] Parse real ip instead of the ip provided by ASP.NET Core framework

Description

The ip provided by ASP.NET Core framework is generated from configurations like localhost.

Task List

No response

[Task] Add license files for the dependencies and add release note

Description

Add license files for the dependencies and add release note

Task List

No response

代理接口访问不到

Is there an existing issue for this?

• I have searched the existing issues

Current Behavior

netcore程序已经注册进shenyu，界面上已经显示。使用postman请求代理接口不通。本地启动是可以用本机ip或者localhost访问接口， 不通过代理访问接口。当初以为是docker容器没开放访问本机权限，下载java程序到本地启动，netcore程序改成访问本地java程序，正常注册进shenyu，不过再次尝试使用postman请求代理接口不通

Expected Behavior

能够访问代理后的接口，想请问下是设置问题还是操作不当引起

Steps To Reproduce

No response

Environment

ShenYu version(s):最新master分支

Debug logs

现象：接口http://127.0.0.1:9195/dotnet2/template/hello 访问不通

shenyu界面：

netcore启动：localhost和本机ip都是可以正常直接访问相应接口
netcore配置：
"Shenyu": {
"Register": {
"ServerList": "http://127.0.0.1:9095",
"RegisterType": "http",
"Props": {
"UserName": "admin",
"Password": "123456"
}
},
"Client": {
"AppName": "dotnet-example2",
"ContextPath": "/dotnet2",
"IsFull": false,
"ClientType": "http"
}
}

java程序：

Anything else?

No response

[Task] Add Unit Test for Shenyu dotnet client

Description

Add Unit Test, welcome to contribute if you're interested~
You can let me know and I'll create sub ISSUE for specific UT and linked to this issue.

Task List

No response

[Task] Change version to 1.0.0

Description

Change version to 1.0.0

Task List

No response

[Task] support register by consul

Description

support register by consul.

Task List

No response

[Task] Document about http, zookeeper, consul and nacos registration

Description

Document about http, zookeeper, consul and nacos registration

Task List

No response

[Task] Add CI for building, testing, license checking and codeQL check

Description

Add CI for building, testing, license checking and codeQL check. Will add code coverage and integrated test ci in future PR.

Task List

1. add ci for building for both .net5 and 6, and for win, mac and linux
2. add license checker when PR and push to main
3. add code QL
4. add test CI and add only one UT for this time to check if it works well.

[Task] Create ISSUE templates and PR template

Add issue templates and PR template for this repo. Referred the templates in incubator-shenyu project.

[Task] Fix typo, add `global.json` for SDK version, and improve logs

Description

Enhancement for shenyu dotnet client, more details can see in Task List.

Task List

1. Fix typo for the namespace of ShenyuClientAttribute.
2. Add more register logs.
3. Add version and other information in Apache.ShenYu.Client and Apache.ShenYu.AspNetCore projects

[Task] Remove bin and obj directory when running `dotnet clean`

Description

Current behaviour will not remove these directories.

Task List

No response

[Task] Organize LICENSE files and dependencies

Description

organize license files and all the dependencies and it's LICENSEs, including in-direct dependencies.

Task List

No response

[Question] It is recommended to modify the support for .NET Framework 4.6.1 and upgrade the supported version of ASP.NET Core

Question

ASP.NET Core >= 5 no longer supports .NET Framework, Only run .NET Core. The new ASP.NET Core brings many feature changes, especially 3.1->5.0, if the multi-target framework is used to support it, it will complicate the code and increase the maintenance cost, and ASP.NET Core <= 3.1 is already an older version.

If you want to support .NET Framework I recommend maintaining a separate project (Library)

Then upgrade the supported version of the class library to .NET 5.0, 6.0

I can get the job done if the suggestion is taken.

[Task] use .editorconfig for code style

Description

Using .editorconfig to enforce consistent coding styles. More details can visit this doc. https://docs.microsoft.com/en-us/visualstudio/ide/create-portable-custom-editor-options?view=vs-2022

Task List

No response