MoonWalker JSON API Documentation

Documentation for MoonWalker JSON API

Prerequisites

• Node.js
• NPM
• Git
• GitHub CLI (Optional)

Introduction

MoonWalker JSON API is an API creation tool for easier API-building.

Each Route can be written in JavaScript or JSON.

Each Route has a folder containing its own files.

A Route can be linked by updating the /config/routes.json file.

Currently, Only GET routes can be made in the MoonWalker JSON API.

Documentation

Creating MoonWalker JSON API.

• Method One - MoonWalker CLI

$ npm i -g create-moonwalker-app

$ create-moonwalker-app create-api <directory-name>

• Method Two - Clone Github Repository

• gh (GitHub CLI)

gh repo clone MoonWalkerHTTP/moonwalker-json-api-template <directory-name>

• git

git clone https://github.com/MoonWalkerHTTP/moonwalker-json-api-template.git <directory-name>

Starting MoonWalker JSON API.

Production Server -

npm start

Development Server -

npm run dev

Port

The default port for a MoonWalker JSON API is 5000.

To change the Default Port, Open /config/serverConfig.json and edit the value for port.

Deployment / Hosting (On a VPS)

MoonWalker JSON APIs can be deployed on many platforms such as DigitalOcean and Linode as it is bascically a Node.js Project.

Slash Route (JavaScript)

After Starting the Development Server, visit localhost:5000 on your Web Browser.

After the page loads up, You will see a basic Hello World JSON Response. This is the index route.

For Editing the Index Route, Open the Directory in your preffered Code editor and open the app directory. There you will see a folder / directory named index open it and you will see an index.js file.

For Editing the Response, You can edit the constant response which is an object and the changes will show upon refreshing.

/jsonExample Route (JSON)

In the MoonWalker JSON API, You have 2 options to respond to a request, You can either use JSON or use JavaScript for advanced responses.

The /jsonExample Route is written in JSON.

You can edit the File and the changes will show upon refreshing.

Creating a New Route (JSON).

For Creating a new Route, create a new folder in the app directory and name it as your route. In the Below Example, we will use the example /joke.

I will first create a new directory in the app folder called joke.

Then I will create a JSON file in the joke directory called joke.json.

I Will Update the joke.json as follows -

{
    "joke": "Why Did the Cow cross the Road? Because it wanted to watch a MOOvie"
}

Now, For the Route to show up, I will update the file /config/routes.json.

I will Update it as follows -

[
     {
          "id": "0",
          "description": "Index", 
          "route": "/",
          "renderFile": "/index/index.js"
     }, 
     {
          "id": "1", 
          "description": "IndexJSON", 
          "route": "/jsonExample", 
          "renderFile": "/indexJSON/index.json"
     }, 
     {
          "id": "2", 
          "description": "Joke", 
          "route": "/joke", 
          "renderFile": "/joke/joke.json"
     }
]

Now, Upon Refreshing, my joke will show up.

Creating a new Route (JavaScript)

For Creating a new Route, create a new folder in the app directory and name it as your route. In the Below Example, we will use the example /joke.

I will first create a new directory in the app folder called joke.

Then I will create a JavaScript file in the joke directory called joke.js.

I Will Update the joke.js as follows -

const response = {
    joke: "Why did the cow cross the road? Because it wanted to watch a MOOvie."
}

module.exports = response;

Now, For the Route to show up, I will update the file /config/routes.json.

I will Update it as follows -

[
     {
          "id": "0",
          "description": "Index", 
          "route": "/",
          "renderFile": "/index/index.js"
     }, 
     {
          "id": "1", 
          "description": "IndexJSON", 
          "route": "/jsonExample", 
          "renderFile": "/indexJSON/index.json"
     }, 
     {
          "id": "2", 
          "description": "Joke", 
          "route": "/joke", 
          "renderFile": "/joke/joke.js"
     }
]

Congratulations! You Successfully Created a new Route.