https://github.com/startxfr/sxapi-sample

Sample config file for sxapi project
https://github.com/startxfr/sxapi-sample

Last synced: about 2 months ago
JSON representation

Sample config file for sxapi project

• Host: GitHub
• URL: https://github.com/startxfr/sxapi-sample
• Owner: startxfr
• License: gpl-3.0
• Created: 2016-10-28T17:59:16.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-11-21T06:54:51.000Z (over 4 years ago)
• Last Synced: 2025-02-10T00:26:24.420Z (3 months ago)
• Language: Shell
• Size: 163 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![sxapi](https://raw.githubusercontent.com/startxfr/sxapi-core/dev/docs/assets/logo.svg?sanitize=true)](https://github.com/startxfr/sxapi-core)

# sxapi-core examples ![sxapi](https://img.shields.io/badge/latest-v0.0.66-blue.svg)

This repository store various samples files for configuring API microservices 

powered by [sxapi-core framework](https://github.com/startxfr/sxapi-core)

[![Build Status](https://travis-ci.org/startxfr/sxapi-sample.svg?branch=dev)](https://travis-ci.org/startxfr/sxapi-sample)

[![docker build](https://img.shields.io/docker/build/startx/sxapi.svg)](https://hub.docker.com/r/startx/sxapi/) 

[![npm version](https://badge.fury.io/js/sxapi-core.svg)](https://www.npmjs.com/package/sxapi-core) 

[![npm dependencies](https://david-dm.org/startxfr/sxapi-core.svg)](https://www.npmjs.com/package/sxapi-core) 

[![last commit](https://img.shields.io/github/last-commit/startxfr/sxapi-core.svg)](https://github.com/startxfr/sxapi-core) 

[![licence](https://img.shields.io/github/license/startxfr/sxapi-core.svg)](https://github.com/startxfr/sxapi-core) 

# sxapi project

**sxapi** for **s**imple and e**x**tensible **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](https://github.com/startxfr/sxapi-core) for more information about this framework

# running an example

You will find configuration samples in [samples/](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](samples/) Various configuration examples

  - [AWS](aws/) Configuration examples using AWS services

  - [DB](db/) Configuration examples using Database backends

  - [full](full/) Configuration example using all features

  - [simple](simple/) Configuration examples using simple endpoints

  - [websocket](websocket/) Configuration example with websocket connection

# Troubleshooting

If you run into difficulties installing or running sxapi, you can [create an issue](https://github.com/startxfr/sxapi-core/issues/new).

# Built With

* [docker](https://www.docker.com/) - Container plateform

* [alpine](https://alpinelinux.org/) - OS envelop

* [nodejs](https://nodejs.org) - Application server

* [express](http://expressjs.com) - Web framework

# Contributing

Read the [contributing guide](https://github.com/startxfr/sxapi-core/tree/dev/docs/guides/5.Contribute.md) for details on our code of conduct, and the process for submitting pull requests to us.

# Authors

This project is mainly developped by the [startx](https://www.startx.fr) dev team. You can see the complete list of contributors who participated in this project by reading [CONTRIBUTORS.md](https://github.com/startxfr/sxapi-core/tree/dev/docs/CONTRIBUTORS.md).

# License

This project is licensed under the GPL Version 3 - see the [LICENSE](https://github.com/startxfr/sxapi-core/tree/dev/docs/LICENSE) file for details