Skapi

Appearance

Getting Started ​

Welcome to Skapi, this guide will walk you through importing the Skapi library into your project, creating a service, and connecting your application to your Skapi server.

1. Create a service ​

  1. Signup for an account at skapi.com.
  2. Login and go to My Services page.
  3. Enter your new service name and click 'Create'.

2. Initialize the Skapi library ​

Skapi is compatible with both vanilla HTML and webpack-based projects (ex. Vue, React, Angular... etc). You need to import the library using the <script> tag or install via npm.

For HTML projects ​

For vanilla HTML projects, import Skapi in the script tag, and initialize the library.

html
<!-- index.html -->
<!DOCTYPE html>
<script src="https://cdn.jsdelivr.net/npm/skapi-js@latest/dist/skapi.js"></script>
<script>
    const skapi = new Skapi('service_id', 'owner_id');
</script>

For SPA projects ​

To use Skapi in a SPA projects (such as Vue, React, or Angular), you can install skapi-js via npm.

sh
$ npm i skapi-js

Then, import the library into your main JavaScript file.

javascript
// main.js
import { Skapi } from 'skapi-js';
const skapi = new Skapi('service_id', 'owner_id');

export { skapi }

// Now you can import skapi from anywhere in your project.

WARNING

Be sure to replace 'service_id' and 'owner_id' in new Skapi() with the actual values of your service.

3. Test your connection ​

After you initialized the Skapi library, you can test your connection by pinging your request with the mock() method.

Below is an example of how you can use the mock() method in both HTML forms and SPA code.

html
<!-- index.html -->
<!DOCTYPE html>
<script src="https://cdn.jsdelivr.net/npm/skapi-js@latest/dist/skapi.js"></script>
<script>
    const skapi = new Skapi('service_id', 'owner_id');
</script>

<form onsubmit='skapi.mock(event).then(ping => alert(ping.msg))'>
    <input name='msg' placeholder='Test message'>
    <input type='submit' value='Test Connection'>
</form>
javascript
import { skapi } from '../location/of/your/main.js';
skapi.mock({msg: 'Hello World!'}).then(ping => alert(ping.msg))

This will send a request to your Skapi service and ping back the response. When the request is resolved, the mock() method will return the response data as a Promise object. The response data will be displayed in an alert box.

TIP

Skapi is capable of handling HTML onsubmit event directly.

For more information, see Working with HTML forms.