SimpleRest.Api.SimpleRestApi Class Reference

Inheritance diagram for SimpleRest.Api.SimpleRestApi:

Collaboration diagram for SimpleRest.Api.SimpleRestApi:

Public Member Functions
	SimpleRestApi (int port, ISimpleRestLogger? logger=null, ISimpleRestContentTypeParser? responseParser=null, ISimpleRestUriTemplateFormatter? uriFormatter=null, ISimpleRestEndpointFormatter? endpointFormatter=null, JsonSerializerOptions? jsonSerializerOptions=null, Type? defaultIntType=null)
void	Use (ISimpleRestApiHandler customHandler)
void	Map (string endpoint, ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	All (ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Options (ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Options (string endpoint, ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Get (string endpoint, ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Get (ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Post (string endpoint, ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Post (ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Put (string endpoint, ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Put (ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Patch (string endpoint, ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Patch (ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Delete (string endpoint, ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Delete (ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Head (string endpoint, ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
void	Head (ApiMiddleWare middleWare, params ISimpleRestRouteHandler[] routeHandlers)
async Task	Start (Action< int, string >? OnStartup=null)
void	Stop ()
void	Dispose ()

Properties
bool	HasStarted = false [get]
bool	Disposed = false [get]

Events
Action< SimpleRestApi >?	OnServerStart
Action< SimpleRestApi >?	OnBeforeRequestCreate
Action< SimpleRestApi, SimpleRestRequest >?	OnRequestCreate
Action< SimpleRestApi, SimpleRestRequest >?	OnBeforeResponseCreate
Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse >?	OnResponseCreate
Action< SimpleRestApi, SimpleRestRequest >?	OnLog
Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse, Dictionary< UriTemplateMatch, SimpleRestMap > >?	OnHandleRequestStack
Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse, UriTemplateMatch, SimpleRestMap >?	OnRequestMatch
Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse, UriTemplateMatch, SimpleRestMap >?	OnApplyUriParams
Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse, UriTemplateMatch, SimpleRestMap >?	OnBeforeRunMiddleware
Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse, UriTemplateMatch, SimpleRestMap >?	OnRunMiddleware
Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse >?	OnBeforeRequestEnd
Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse >?	OnRequestEnd

Detailed Description

Definition at line 14 of file SimpleRestApi.cs.

Constructor & Destructor Documentation

SimpleRestApi()

SimpleRest.Api.SimpleRestApi.SimpleRestApi	(	int	port,
		ISimpleRestLogger?	logger = null,
		ISimpleRestContentTypeParser?	responseParser = null,
		ISimpleRestUriTemplateFormatter?	uriFormatter = null,
		ISimpleRestEndpointFormatter?	endpointFormatter = null,
		JsonSerializerOptions?	jsonSerializerOptions = null,
		Type?	defaultIntType = null )

Definition at line 72 of file SimpleRestApi.cs.

Member Function Documentation

All()

void SimpleRest.Api.SimpleRestApi.All	(	ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 159 of file SimpleRestApi.cs.

Delete() [1/2]

void SimpleRest.Api.SimpleRestApi.Delete	(	ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 243 of file SimpleRestApi.cs.

Delete() [2/2]

void SimpleRest.Api.SimpleRestApi.Delete	(	string	endpoint,
		ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 234 of file SimpleRestApi.cs.

Dispose()

void SimpleRest.Api.SimpleRestApi.Dispose

(

)

Definition at line 425 of file SimpleRestApi.cs.

Here is the call graph for this function:

Get() [1/2]

void SimpleRest.Api.SimpleRestApi.Get	(	ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 187 of file SimpleRestApi.cs.

Get() [2/2]

void SimpleRest.Api.SimpleRestApi.Get	(	string	endpoint,
		ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 178 of file SimpleRestApi.cs.

Head() [1/2]

void SimpleRest.Api.SimpleRestApi.Head	(	ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 257 of file SimpleRestApi.cs.

Head() [2/2]

void SimpleRest.Api.SimpleRestApi.Head	(	string	endpoint,
		ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 248 of file SimpleRestApi.cs.

Map()

void SimpleRest.Api.SimpleRestApi.Map	(	string	endpoint,
		ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 150 of file SimpleRestApi.cs.

Options() [1/2]

void SimpleRest.Api.SimpleRestApi.Options	(	ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 164 of file SimpleRestApi.cs.

Here is the caller graph for this function:

Options() [2/2]

void SimpleRest.Api.SimpleRestApi.Options	(	string	endpoint,
		ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 169 of file SimpleRestApi.cs.

Patch() [1/2]

void SimpleRest.Api.SimpleRestApi.Patch	(	ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 229 of file SimpleRestApi.cs.

Patch() [2/2]

void SimpleRest.Api.SimpleRestApi.Patch	(	string	endpoint,
		ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 220 of file SimpleRestApi.cs.

Post() [1/2]

void SimpleRest.Api.SimpleRestApi.Post	(	ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 201 of file SimpleRestApi.cs.

Post() [2/2]

void SimpleRest.Api.SimpleRestApi.Post	(	string	endpoint,
		ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 192 of file SimpleRestApi.cs.

Put() [1/2]

void SimpleRest.Api.SimpleRestApi.Put	(	ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 215 of file SimpleRestApi.cs.

Put() [2/2]

void SimpleRest.Api.SimpleRestApi.Put	(	string	endpoint,
		ApiMiddleWare	middleWare,
		params ISimpleRestRouteHandler[]	routeHandlers )

Definition at line 206 of file SimpleRestApi.cs.

Start()

async Task SimpleRest.Api.SimpleRestApi.Start

(

Action< int, string >?

OnStartup = null

)

Parameters

OnStartup

Returns

Definition at line 267 of file SimpleRestApi.cs.

Here is the call graph for this function:

Stop()

void SimpleRest.Api.SimpleRestApi.Stop

(

)

Definition at line 416 of file SimpleRestApi.cs.

Here is the caller graph for this function:

Use()

void SimpleRest.Api.SimpleRestApi.Use

(

ISimpleRestApiHandler

customHandler

)

Definition at line 145 of file SimpleRestApi.cs.

Property Documentation

Disposed

bool SimpleRest.Api.SimpleRestApi.Disposed = false

get

Definition at line 28 of file SimpleRestApi.cs.

HasStarted

bool SimpleRest.Api.SimpleRestApi.HasStarted = false

get

Definition at line 27 of file SimpleRestApi.cs.

Event Documentation

OnApplyUriParams

Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse, UriTemplateMatch, SimpleRestMap >? SimpleRest.Api.SimpleRestApi.OnApplyUriParams

Definition at line 54 of file SimpleRestApi.cs.

OnBeforeRequestCreate

Action<SimpleRestApi>? SimpleRest.Api.SimpleRestApi.OnBeforeRequestCreate

Definition at line 30 of file SimpleRestApi.cs.

OnBeforeRequestEnd

Action<SimpleRestApi, SimpleRestRequest, SimpleRestResponse>? SimpleRest.Api.SimpleRestApi.OnBeforeRequestEnd

Definition at line 69 of file SimpleRestApi.cs.

OnBeforeResponseCreate

Action<SimpleRestApi, SimpleRestRequest>? SimpleRest.Api.SimpleRestApi.OnBeforeResponseCreate

Definition at line 32 of file SimpleRestApi.cs.

OnBeforeRunMiddleware

Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse, UriTemplateMatch, SimpleRestMap >? SimpleRest.Api.SimpleRestApi.OnBeforeRunMiddleware

Definition at line 61 of file SimpleRestApi.cs.

OnHandleRequestStack

Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse, Dictionary<UriTemplateMatch, SimpleRestMap> >? SimpleRest.Api.SimpleRestApi.OnHandleRequestStack

Definition at line 40 of file SimpleRestApi.cs.

OnLog

Action<SimpleRestApi, SimpleRestRequest>? SimpleRest.Api.SimpleRestApi.OnLog

Definition at line 34 of file SimpleRestApi.cs.

OnRequestCreate

Action<SimpleRestApi, SimpleRestRequest>? SimpleRest.Api.SimpleRestApi.OnRequestCreate

Definition at line 31 of file SimpleRestApi.cs.

OnRequestEnd

Action<SimpleRestApi, SimpleRestRequest, SimpleRestResponse>? SimpleRest.Api.SimpleRestApi.OnRequestEnd

Definition at line 70 of file SimpleRestApi.cs.

OnRequestMatch

Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse, UriTemplateMatch, SimpleRestMap >? SimpleRest.Api.SimpleRestApi.OnRequestMatch

Definition at line 47 of file SimpleRestApi.cs.

OnResponseCreate

Action<SimpleRestApi, SimpleRestRequest, SimpleRestResponse>? SimpleRest.Api.SimpleRestApi.OnResponseCreate

Definition at line 33 of file SimpleRestApi.cs.

OnRunMiddleware

Action< SimpleRestApi, SimpleRestRequest, SimpleRestResponse, UriTemplateMatch, SimpleRestMap >? SimpleRest.Api.SimpleRestApi.OnRunMiddleware

Definition at line 68 of file SimpleRestApi.cs.

OnServerStart

Action<SimpleRestApi>? SimpleRest.Api.SimpleRestApi.OnServerStart

Definition at line 29 of file SimpleRestApi.cs.

---

The documentation for this class was generated from the following file:

• /home/runner/work/SimpleRest.NET/SimpleRest.NET/Src/Api/SimpleRestApi.cs