Resource Web Access - Revision history

Botder: Add new-feature-item wrapper for router

2024-08-25T14:32:30Z

Add new-feature-item wrapper for router

← Older revision		Revision as of 14:32, 25 August 2024
Line 7:		Line 7:
	* '''Pages:''' The ability to serve any http items (specified the meta.xml) as a page or file.		* '''Pages:''' The ability to serve any http items (specified the meta.xml) as a page or file.
	* '''Calls:''' The ability to call any exported http functions (specified in the meta.xml).		* '''Calls:''' The ability to call any exported http functions (specified in the meta.xml).
	* '''Router:''' Use a designated http function to route requests within a resource manually (overriding the two parts above).		{{New feature/item\|3.0161\|1.6.0\|22639\|* '''Router:''' Use a designated http function to route requests within a resource manually (overriding the two parts above).}}

	==Pages==		==Pages==
Line 143:		Line 143:

	==Router==		==Router==
			{{New feature/item\|3.0161\|1.6.0\|22639\|
	A router is a function that overrides both the function call mechanism and basic web server functionality, to allow a scripter to personalize the routing and client-response for each resource separately. For example, this allows a scripter to write an '''api''' named resource with a router function, that can serve any sort of information in a RESTy fashion. You may also take this further, and name the resource '''v1''' (or '''v2'''...) for easy API versioning. You can spin up and down the different resources as you wish, and users of your API can continue using an older version this way.		A router is a function that overrides both the function call mechanism and basic web server functionality, to allow a scripter to personalize the routing and client-response for each resource separately. For example, this allows a scripter to write an '''api''' named resource with a router function, that can serve any sort of information in a RESTy fashion. You may also take this further, and name the resource '''v1''' (or '''v2'''...) for easy API versioning. You can spin up and down the different resources as you wish, and users of your API can continue using an older version this way.
			}}

	===How to setup a router function===		===How to setup a router function===

Botder at 19:37, 24 August 2024

2024-08-24T19:37:26Z

← Older revision		Revision as of 19:37, 24 August 2024
Line 159:		Line 159:

	===Request===		===Request===
	This section describes all the fields, that can be found in the '''request''' table passed to the router function for every call. The descriptions below use the following example URL ~~for the descriptions~~:		This section describes all the fields, that can be found in the '''request''' table passed to the router function for every call. The descriptions below use the following example URL:

	<code>http://127.0.0.1:22005/api/vehicles/123?meow=true</code> ('''api''' is the resource name)		<code>http://127.0.0.1:22005/api/vehicles/123?meow=true</code> ('''api''' is the resource name)

Botder at 19:36, 24 August 2024

2024-08-24T19:36:27Z

← Older revision		Revision as of 19:36, 24 August 2024
Line 143:		Line 143:

	==Router==		==Router==
	A router is a function that overrides both the function call mechanism and basic web server functionality, to allow a scripter to personalize the routing and client-response for ~~a single~~ resource. For example, this allows a scripter to write an '''api''' named resource with a router function, that can serve any sort of information in a RESTy fashion. You may also take this further, and name the resource '''v1''' (or '''v2'''...) for easy API versioning. You can spin up and down the different resources as you wish, and users of your API can continue using an older version this way.		A router is a function that overrides both the function call mechanism and basic web server functionality, to allow a scripter to personalize the routing and client-response for each resource separately. For example, this allows a scripter to write an '''api''' named resource with a router function, that can serve any sort of information in a RESTy fashion. You may also take this further, and name the resource '''v1''' (or '''v2'''...) for easy API versioning. You can spin up and down the different resources as you wish, and users of your API can continue using an older version this way.

	===How to setup a router function===		===How to setup a router function===

Botder: Add HTTP router function information

2024-08-24T19:34:23Z

Add HTTP router function information

@@ Line 4: / Line 4: @@
 ==Overview==
-There are two key parts that make up this system. The first is a standard web server that allows web browsers to request pages and files you have in a resource. The second is a system for allowing web browsers to call functions you have exported from your resource.
+There are three key parts that make up this system.
 ==Pages==
@@ Line 138: / Line 141: @@
 You can see (fairly complex) examples of how this can be done in the resources ''resourcebrowser'', ''resourcemanager'' and ''webadmin''.
 ==Securing the web interface==

Ceevyl: /* SDK */

2023-08-20T03:55:41Z

SDK

← Older revision		Revision as of 03:55, 20 August 2023
Line 162:		Line 162:
	* [https://www.npmjs.com/package/mtasa Node.js SDK]		* [https://www.npmjs.com/package/mtasa Node.js SDK]
	* [https://crates.io/crates/mta-sdk Rust SDK]		* [https://crates.io/crates/mta-sdk Rust SDK]
	* [https://pypi.org/project/MTA-SDK-Python/]		* [https://pypi.org/project/MTA-SDK-Python/ Python SDK]
	* [[Perl SDK]]		* [[Perl SDK]]
	* [[PHP SDK]]		* [[PHP SDK]]

Ceevyl: /* SDK */

2023-08-20T03:54:18Z

SDK

← Older revision		Revision as of 03:54, 20 August 2023
Line 162:		Line 162:
	* [https://www.npmjs.com/package/mtasa Node.js SDK]		* [https://www.npmjs.com/package/mtasa Node.js SDK]
	* [https://crates.io/crates/mta-sdk Rust SDK]		* [https://crates.io/crates/mta-sdk Rust SDK]
			* [https://pypi.org/project/MTA-SDK-Python/]
	* [[Perl SDK]]		* [[Perl SDK]]
	* [[PHP SDK]]		* [[PHP SDK]]

Z4: /* SDK */

2023-08-19T13:23:35Z

SDK

← Older revision		Revision as of 13:23, 19 August 2023
Line 161:		Line 161:
	* [[Javascript SDK]]		* [[Javascript SDK]]
	* [https://www.npmjs.com/package/mtasa Node.js SDK]		* [https://www.npmjs.com/package/mtasa Node.js SDK]
			* [https://crates.io/crates/mta-sdk Rust SDK]
	* [[Perl SDK]]		* [[Perl SDK]]
	* [[PHP SDK]]		* [[PHP SDK]]

Myonlake: /* Parsed files */

2021-09-20T14:51:12Z

Parsed files

← Older revision		Revision as of 14:51, 20 September 2021
Line 53:		Line 53:
	* string '''url''': This is the URL of the page.		* string '''url''': This is the URL of the page.
	* account '''user''': This is the account of the current user.		* account '''user''': This is the account of the current user.
			{{New feature/item\|3.0159\|1.5.8\|20828\|
			* string '''requestBody''': This is the request body.
			* string '''method''': This is the request method.
			}}

	It's important to note that parsed files are run in a separate virtual machine from the rest of your resource's code. As such, if you want to call a function in your resource's main code, you need to export the function and use the [[call]] function from your parsed file.		It's important to note that parsed files are run in a separate virtual machine from the rest of your resource's code. As such, if you want to call a function in your resource's main code, you need to export the function and use the [[call]] function from your parsed file.

Myonlake at 21:49, 21 February 2021

2021-02-21T21:49:04Z

← Older revision		Revision as of 21:49, 21 February 2021
Line 165:		Line 165:
	[[Category:Scripting Concepts]]		[[Category:Scripting Concepts]]

			[[en:Resource Web Access]]
			[[fr:Ressource Acces Internet]]
	[[hu:Resource Web Access]]		[[hu:Resource Web Access]]
			[[pt-br:Acesso_web_via_recursos]]
	[[ru:Resource Web Access]]		[[ru:Resource Web Access]]
	~~[[pt-br:Acesso_web_via_recursos]]~~

	[[Category:Tutorials]]		[[Category:Tutorials]]

Cristiano Cardoso: add link to pt-br page

2021-01-21T15:57:26Z

add link to pt-br page

← Older revision		Revision as of 15:57, 21 January 2021
Line 167:		Line 167:
	[[hu:Resource Web Access]]		[[hu:Resource Web Access]]
	[[ru:Resource Web Access]]		[[ru:Resource Web Access]]
			[[pt-br:Acesso_web_via_recursos]]

	[[Category:Tutorials]]		[[Category:Tutorials]]