blob: af75719bd1549a2792199d0b19d665929ccdb200 [file] [log] [blame] [view]
# HTTP Registration get start
## ASP.NET Core project
For ASP.NET Core project, we can refer to the example code at `examples/AspNetCoreExample`. What you need to do is quite
simple and straightforward.
1. add the Shenyu ASP.NET Core dependency into project.
```shell
dotnet add package <todo-shenyu-asp.net-core package>
```
2. in `Startup.ConfigureServices` method, add the `ShenyuRegister` service.
```c#
public void ConfigureServices(IServiceCollection services)
{
...
services.AddShenyuRegister(this.Configuration);
...
}
```
3. set your `Shenyu` configurations in `appsettings.json`.
```json
{
"Shenyu": {
"Register": {
"RegisterType": "zookeeper",
"ServerList": "localhost:2181",
"Props": {
// 3000 ms by default
"SessionTimeout": 60000,
//3000 ms by default
"ConnectionTimeout": 60000,
// 1000 ms by default
"OperatingTimeout": 1000,
// digest
"Digest": "",
}
},
"Client": {
"AppName": "dotnet-example",
"ContextPath": "/dotnet",
"IsFull": false,
"ClientType": "http"
}
}
}
```
4. 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"`
```shell
export ASPNETCORE_URLS=http://+:5000
```
5. start the application.
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.
```shell
# build project
dotnet build --configuration Release
# start project
cd examples/AspNetCoreExample/bin/Release/netcoreapp3.1
dotnet AspNetCoreExample.dll
```