sxapi-core
Advanced tools
sxapi-core is an simple and extensible framework for building microservices API using javascript technologies
Build status : 
sxapi for simple and extensible api (Application Programming Interface) is an an open-source framework for quickly building simple and small API based on microservice architecture.
Very light (application less than 100Ko, full container stack for less than 30Mo) and configured with a single json file, you can build instantly small atomic API endpoints as well as fully featured enterprise-sized API.
sxapi is shipped in 3 ways :
To try this application before working on it, the easiest way is to use the container version. Follow theses steps to run a sxapi application within the next couple of minutes. (You can skip the first step if you already have docker installed and running)
Theses command are for a Red Hat Linux like
environement (Fedora, CentOS, RHEL, Suse). Please adapt yum command to the
apt-get equivalent if you are using a Debian like system (Ubuntu, Debian)
sudo yum install -y docker
sudo service docker start
For more information on how to install and execute a docker runtime, please see the official docker installation guide After installation, pay attention to your user authorisation. Your current user must interact with the docker daemon.
To run you test in a sandbox, you should isolate your sxapi test from your current work by creating a working directory.
mkdir ~/test-sxapi
cd ~/test-sxapi
Use docker command to get sxapi container image from the docker hub registry. This will update your local docker image cache.
docker pull startx/sxapi:latest
Create a file named sxapi.json
vi ~/test-sxapi/sxapi.json
Edit it with the following content
{
"name": "sample-api",
"description": "my sample api using sxapi-core framework",
"version": "0.0.0",
"debug": true,
"log": {
"filters": {
"level": "0,1,2,3,4",
"type": "debug,info,error,warn"
}
},
"server": {
"endpoints": [
{
"path": "/",
"body": "<html><head></head><body><h1>My sample API</h1></body></html>"
}
]
}
}
You can change name, description, version and
server.endpoints.body with personalized content
docker run -d -p 8080:8080 -v ~/test-sxapi/sxapi.json:/conf/sxapi.json:ro startx/sxapi
Connect to http://localhost:8080/ with your favorite navigator. You should
see an html message "My Sample API".
sxapi-core come with many components to help you build your own api. 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.
To help you understand how you can configure your api, you can :
For more information on how to use this project as a container, see use docker image
For more information on how to change your configuration file and create an API relflecting your needs, please read carefully our building api user guide
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 full documentation or our user guides sections :
If you run into difficulties installing or running sxapi, please report issue for installer or issue for sxapi.
Please read contributing guide for details on our code of conduct, and the process for submitting pull requests to us.
This project is mainly developped by the startx dev team. You can see the complete list of contributors who participated in this project by reading CONTRIBUTORS.md.
This project is licensed under the GPL Version 3 - see the LICENSE.md file for details
FAQs
sxapi-core is an simple and extensible framework for building microservices API using javascript technologies
The npm package sxapi-core receives a total of 105 weekly downloads. As such, sxapi-core popularity was classified as not popular.
We found that sxapi-core demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.