sxapi-core examples sxapi

This repository store various samples files for configuring API microservices powered by sxapi-core framework

Build Status docker build npm version npm dependencies last commit licence

sxapi project

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.

see sxapi-core project for more information about this framework

running an example

You will find configuration samples in samples/ directory. Every sample have a README file describing how you can run this sample. Please follow the described steps to see the running sample

  • samples Various configuration examples
  • AWS Configuration examples using AWS services
  • DB Configuration examples using Database backends
  • full Configuration example using all features
  • simple Configuration examples using simple endpoints
  • websocket Configuration example with websocket connection


If you run into difficulties installing or running sxapi, you can create an issue.

Built With


Read the 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


This project is licensed under the GPL Version 3 - see the LICENSE file for details