Skip to main content
Version: Next

HTTP Registration get start

ASP.NET Core project#

For ASP.NET Core project, we can refer to the example code at example code. What you need to do is quite simple and straightforward.

  1. add the Shenyu ASP.NET Core dependency into project.
dotnet add package Apache.ShenYu.AspNetCore
  1. in Startup.ConfigureServices method, add the ShenyuRegister service.
public void ConfigureServices(IServiceCollection services){    ...    services.AddShenyuRegister(this.Configuration);    ...}
  1. set your Shenyu configurations in appsettings.json.
{  "Shenyu": {    "Register": {      "RegisterType": "http",      "ServerList": "http://localhost:9095",      "Props": {        // your admin user name        "UserName": "admin",        // your admin password        "Password": "123456"      }    },    "Client": {      "AppName": "dotnet-example",      "ContextPath": "/dotnet",      "IsFull": false,      "ClientType": "http"    }  }}
  1. enable calling via ip.

When running on your local machine, ASP.NET Core service can only be called from localhost. To enable calling by IP, you can replace https://localhost:{port};http://localhost:{port} with https://*:{port};http://*:{port}

Setting by environment variables ASPNETCORE_URLS. e.g. ASPNETCORE_URLS "http://*:5000"

export ASPNETCORE_URLS=http://+:5000
  1. start the application.
# build projectdotnet build --configuration Release# start projectcd examples/AspNetCoreExample/bin/Release/netcoreapp3.1dotnet AspNetCoreExample.dll

That's all! After finished above steps, you can start your project in IDE or below commands and you can visit shenyu-admin portal to see the APIs have been registered in Shenyu.

Last updated on by loongs-zhang