Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/startxfr/sxapi-core
Framework for building Simple and eXtensible API using 100% of Javascript.
https://github.com/startxfr/sxapi-core
api-server api-service docker-image microservices node-module nodejs-modules
Last synced: 28 days ago
JSON representation
Framework for building Simple and eXtensible API using 100% of Javascript.
- Host: GitHub
- URL: https://github.com/startxfr/sxapi-core
- Owner: startxfr
- License: gpl-3.0
- Created: 2016-10-28T17:58:39.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-09-21T20:33:39.000Z (about 2 months ago)
- Last Synced: 2024-10-05T00:33:49.043Z (about 1 month ago)
- Topics: api-server, api-service, docker-image, microservices, node-module, nodejs-modules
- Language: JavaScript
- Homepage:
- Size: 2.48 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# sxapi-core project 
[](https://github.com/startxfr/sxapi-core)
[](https://sxapi-core.readthedocs.io)
[](https://travis-ci.org/startxfr/sxapi-core)
[](https://hub.docker.com/r/startx/sxapi/)
[](https://www.npmjs.com/package/sxapi-core)
**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.
This is the main documentation for the sxapi-core project. You can get some sample code and components usage by [reading the documentation](https://sxapi-core.readthedocs.io).
## Getting Started
- [container image](https://hub.docker.com/r/startx/sxapi) published in dockerhub public registry
The simplest and fastest way to get a running sxapi application is to use the public docker image. For more information on how to run your first sxapi application using sxapi docker image, please read the [docker image user guide](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/USE_docker.md)
- [npm module](https://www.npmjs.com/package/sxapi-core) published in npm public database
If you plan to develop your own component or embed you api into another application, you should be more interested by the npm method. For more information on how to run your first sxapi application using sxapi npm module, please read the [npm module user guide](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/USE_npm.md)
- [source code](https://github.com/startxfr/sxapi-core/tree/testing) published in github
If you plan to extend sxapi capabilities with your own component, change default software design, extend core functinalities or more globaly improve this application, please read the [source code user guide](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/USE_source.md)
## Want to try
- [Docker user guide](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/USE_docker.md)
- [NodJS user guide](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/USE_npm.md)
- [Source code user guide](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/USE_source.md)
You can also use the examples templates designed for openshift to deploy instantly a
[simple app](./examples/okd-app_example-simple.template.yml), a
[bot daemon](./examples/okd-app_example-bot.template.yml) or a
[full application](./examples/okd-app_example-full.template.yml)
## Creating your own 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.yml` config file and implement api endpoints you want to create.
To help you understand how you can configure your api, you can :
1. Visit [sxapi-core official documentation](https://github.com/startxfr/sxapi-core/tree/testing/docs/index.md) and read carefully the [configure section](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/2.Configure.md)
2. Visit [sxapi-sample project](https://github.com/startxfr/sxapi-sample) 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 [full documentation](https://github.com/startxfr/sxapi-core/tree/testing/docs/index.md) or our [user guides](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/index.md) and execute the following steps :
1. [Install sxapi framework](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/1.Install.md)
2. [Configure you API](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/2.Configure.md)
3. [Run you application](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/3.Run.md)
4. [Develop sxapi resource](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/4.Develop.md)
5. [Contribute to sxapi project](https://github.com/startxfr/sxapi-core/tree/testing/docs/guides/5.Contribute.md)
## Release notes
If you want to have more information on a minor release, [read released notes](docs/releases.md)
| Release | Date | Description |
| ------- | ---------- | -------------------------------------------------------------------------------------- |
| 0.3.66 | 2022-11-02 | Upgrade siren2tva to 1.2.0 and all app and dev dependencies. |
| 0.3.63 | 2021-11-22 | Upgrade siren2tva to 1.1.5 and all app and dev dependencies. Reduce to 3 moderate vuln |
| 0.3.61 | 2021-11-21 | Security update of all deps |
| 0.3.59 | 2021-06-26 | Security update of all deps and add sxapi operator documentation |
| 0.3.58 | 2021-05-28 | Security update of all deps |
| 0.3.57 | 2020-09-01 | stabilize aws_s3 resource |
| 0.3.17 | 2019-07-27 | Adding swagger module and improve couchbase support |
| 0.3 | 2019-03-08 | Moving config to yaml syntax |
| 0.2 | 2018-03-18 | Adding bot behavior, event messaging and containerized images |
| 0.1 | 2018-01-20 | Adding all resources, session and websockets |
| beta | 2016-10-29 | micro api componement with log and lightweight webserver |
## 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/testing/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/testing/docs/contributors.md).
## License
This project is licensed under the GPL Version 3 - see the [LICENSE.md](https://github.com/startxfr/sxapi-core/tree/testing/docs/LICENSE.md) file for details