diff --git a/README.md b/README.md index bb0f205..0316544 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Created by [iam1337](https://github.com/iam1337) - [Author Contacts](#author-contacts) ## Introduction -extApi - ... +extApi - It is a simple Http Server, which requires a minimum of specific code to work with. ### Features: @@ -48,7 +48,32 @@ Or if you don't have it, add the scoped registry to manifest.json with the desir ``` ## Examples -... + +To make a simple Web Api, the following lines are enough: +```csharp +// Create Api Server +_api = new Api(); +_api.AddController(new ApiController()); // <--- Add controller +_api.Listen(8080, IPAddress.Any, IPAddress.Loopback); + +// Simple controller example +[ApiRoute("api")] +public class ApiController +{ + [ApiGet("vector/{x}/{y}/{z}")] // GET /api/vector/1/2.5/5 + public ApiResult GetVector(float x, float y, float z) + { + return ApiResult.Ok(new Vector3(x, y, z)); + } + + + [ApiPost("vector")] // POST /api/vector { "x": 1.0, "y": 2.5, "z": 5.0 } + public ApiResult GetVector([ApiBody] Vector vector) + { + // TODO: ... + } +} +``` ## Author Contacts \> [telegram.me/iam1337](http://telegram.me/iam1337)