https://github.com/ba-st/stargate

A library supporting the creation of HTTP based RESTful APIs.
https://github.com/ba-st/stargate

api pharo rest rest-api smalltalk

Last synced: 3 months ago
JSON representation

A library supporting the creation of HTTP based RESTful APIs.

• Host: GitHub
• URL: https://github.com/ba-st/stargate
• Owner: ba-st
• License: mit
• Created: 2018-10-09T20:12:06.000Z (about 6 years ago)
• Default Branch: release-candidate
• Last Pushed: 2024-09-27T19:51:18.000Z (3 months ago)
• Last Synced: 2024-09-28T20:01:58.191Z (3 months ago)
• Topics: api, pharo, rest, rest-api, smalltalk
• Language: Smalltalk
• Homepage:
• Size: 985 KB
• Stars: 32
• Watchers: 8
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Stargate

![Logo](assets/logo.svg)

Stargate is a library supporting the creation of HTTP based RESTful APIs.

[![Pharo Unit Tests](https://github.com/ba-st/Stargate/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/ba-st/Stargate/actions/workflows/unit-tests.yml)

[![GS64 - Unit Tests](https://github.com/ba-st/Stargate/actions/workflows/unit-tests-gs64.yml/badge.svg)](https://github.com/ba-st/Stargate/actions/workflows/unit-tests-gs64.yml)

[![Coverage Status](https://codecov.io/github/ba-st/Stargate/coverage.svg?branch=release-candidate)](https://codecov.io/gh/ba-st/Stargate/branch/release-candidate)

[![Baseline Groups](https://github.com/ba-st/Stargate/actions/workflows/loading-groups.yml/badge.svg)](https://github.com/ba-st/Stargate/actions/workflows/loading-groups.yml)

[![GS64 Components](https://github.com/ba-st/Stargate/actions/workflows/loading-gs64-components.yml/badge.svg)](https://github.com/ba-st/Stargate/actions/workflows/loading-gs64-components.yml)

[![Markdown Lint](https://github.com/ba-st/Stargate/actions/workflows/markdown-lint.yml/badge.svg)](https://github.com/ba-st/Stargate/actions/workflows/markdown-lint.yml)

[![Shellcheck](https://github.com/ba-st/Stargate/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/ba-st/Stargate/actions/workflows/shellcheck.yml)

[![GitHub release](https://img.shields.io/github/release/ba-st/Stargate.svg)](https://github.com/ba-st/Stargate/releases/latest)

[![Pharo 10](https://img.shields.io/badge/Pharo-10-informational)](https://pharo.org)

[![Pharo 11](https://img.shields.io/badge/Pharo-11-informational)](https://pharo.org)

[![GS64 3.7.0](https://img.shields.io/badge/GS64-3.7.0-informational)](https://gemtalksystems.com/products/gs64/)

[![GS64 3.7.1](https://img.shields.io/badge/GS64-3.7.1-informational)](https://gemtalksystems.com/products/gs64/)

Quick links

- [**Explore the docs**](docs/README.md)

- [Report a defect](https://github.com/ba-st/Stargate/issues/new?labels=Type%3A+Defect)

- [Request a feature](https://github.com/ba-st/Stargate/issues/new?labels=Type%3A+Feature)

It's built on top of Teapot and Zinc, providing a conceptual framework to

simplify the creation of RESTful APIs including:

- HATEOAS

- Content negotiation

- API versioning

- ETags

- Pagination

- Operations

## License

- The code is licensed under [MIT](LICENSE).

- The documentation is licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/).

## Installation

To load the project in a Pharo image follow these [instructions](docs/how-to/how-to-load-in-pharo.md).

## Contributing

Check the [Contribution Guidelines](CONTRIBUTING.md)

---

*Icons by [icons8.com](https://icons8.com)*