sxapi-core

SXAPI Core

SXAPI for Simple and eXtensible Application Programming Interface It's an open-source framework for quickly building simple and small microservices API.

Getting Started

sxapi-core is delivered in 2 ways :

Container version

You can use sxapi within a container by using our public official sxapi docker image

1. Get the last version of sxapi container from docker hub registry

docker pull startx/sxapi:latest

1. Run your sample application

docker run startx/sxapi

1. Connect to http://localhost:8080 with your favorite navigator

For more information on how to use this project as a container, see use docker image

NPM version

You can use sxapi with our official sxapi NPM module

1. Create your working environment

mkdir test
cd test
npm install sxapi-core

1. Create a file named app.js and add the following lines

var sxapi = require("sxapi-core");
sxapi.app.launch(function () {
    sxapi.app.log.info("application started", sxapi.app.timer.time('app'));
});

1. Start your application

node app.js

1. Connect to http://localhost:8080 with your favorite navigator

For more information on how to use this project as a npm module, see use npm module

Creating your own API

sxapi-core come with many components to help you build extensible api by using a single json config file. As soon as you have an api instance working, you should focus on making change to your sxapi.json config file and implement api endpoints you want to create.

You must :

1. Visit sxapi-core official documentation and read carefully the develop section
2. Visit sxapi-sample project and explore sample config file to help find sample code or ready-to-use config file

Documentation

If you want to have more information on how to install, develop and run this framework and use it in your project, please read the sxapi official documentation with the following sections :

1. Install sxapi
2. Configure sxapi
3. Run sxapi
4. Develop sxapi resource

Troubleshooting

If you run into difficulties installing or running sxapi, please report issue for installer or
issue for sxapi.

License

SXAPI is licensed under the Apache License, Version 2.0.