Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

filipvrba/mrb-api

Repository files navigation

Mrb API

The "vweb" module of the V programming language is used in this project. The project uses HTTP to communicate with MRuby, which is implemented.

Please note that this repository is now archived and no longer actively maintained.

Content

1 Usage

This API can be used by entering a URL to access it. The application's API host name must be present in the link URL, followed by an access token and a Ruby script.

1.1 Token

There is no requirement to register anyplace, and the access token is public.

The access token is as follows:

kfj1T7dh3ena17yG0xGoeH7Y1983wybJpcBNP6j1

1.2 Example

I'll give the command that gets the output of a Ruby script in json format as an illustration.

Here is the command:

curl "https://mrbapi.fly.dev/?token=kfj1T7dh3ena17yG0xGoeH7Y1983wybJpcBNP6j1&mrb='foo'.capitalize" | json_pp

The terminal displays the following outcome:

{
    "code" : "Result",
    "mrb_code" : "'foo'.capitalize",
    "result" : "Foo"
}

2 Development

The way this project was created makes it available to anyone who knows the URL link. As a result, it is uploaded using Docker to fly.io. My goal is to help folks understand how MRuby might be used in this API project. I advise everyone who is interested in this particular project to read the API Develop article. The article talks about using MRuby to provide a simpler API.

The article is available here:

3 Examples

Several projects may be found here that utilize the MRB API to further handle the result string from the Ruby script.

  • Edu Game - An instructional game that teaches players how to develop Ruby scripts in an interactive manner.

4 Contributors

About

Use the rest api to generate json from mrb functions.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages