Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3scale/APIcast
3scale API Gateway
https://github.com/3scale/APIcast
3scale api-gateway openresty
Last synced: 3 months ago
JSON representation
3scale API Gateway
- Host: GitHub
- URL: https://github.com/3scale/APIcast
- Owner: 3scale
- License: apache-2.0
- Created: 2016-03-15T17:41:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-02T23:33:02.000Z (6 months ago)
- Last Synced: 2024-05-06T15:32:36.295Z (6 months ago)
- Topics: 3scale, api-gateway, openresty
- Language: Lua
- Homepage:
- Size: 7.57 MB
- Stars: 298
- Watchers: 42
- Forks: 168
- Open Issues: 73
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-repositories - 3scale/APIcast - 3scale API Gateway (Lua)
README
# APIcast
[](https://circleci.com/gh/3scale/APIcast/tree/master)
[](https://quay.io/repository/3scale/apicast)
[](https://codecov.io/gh/3scale/apicast)
APIcast is an API gateway built on top of [NGINX](https://www.nginx.com/). It is
part of the [Red Hat 3scale API Management
Platform](https://www.redhat.com/en/technologies/jboss-middleware/3scale).
- [**Getting started**](#getting-started)
- [**Features**](#features)
- [**Development**](#development)
- [**Documentation**](#documentation)
- [**License**](#license)
## Getting started
`master` branch is **not recommended** for production use. For the latest
release, go to the [Releases page](https://github.com/3scale/apicast/releases)
### Docker
You need to specify an `ACCESS_TOKEN`, that you can get from the 3scale admin
portal, and also your `ADMIN_PORTAL_DOMAIN`. If you are using SaaS, it is
`YOUR_ACCOUNT-admin.3scale.net`.
```shell
docker run --name apicast --rm -p 8080:8080 -e THREESCALE_PORTAL_ENDPOINT=https://ACCESS_TOKEN@ADMIN_PORTAL_DOMAIN quay.io/3scale/apicast:master
```
You can use a JSON configuration file instead:
```shell
docker run --name apicast --rm -p 8080:8080 -v $(pwd)/config.json:/opt/app/config.json:ro -e THREESCALE_CONFIG_FILE=/opt/app/config.json quay.io/3scale/apicast:master
```
In this example `config.json` is located in the same directory where the
`docker` command is executed, and it is mounted as a volume at
`/opt/app/config.json`. `:ro` indicates that the volume will be read-only.
The JSON file needs to follow the [schema](schema.json), see an [example
file](examples/configuration/example-config.json) with the fields that are used
by APIcast.
### Openshift
You need to create a secret with your `ACCESS_TOKEN` and your `ADMIN_PORTAL_DOMAIN`:
```shell
oc create secret generic apicast-configuration-url-secret \
--from-literal=password=https://ACCESS_TOKEN@ADMIN_PORTAL_DOMAIN \
--type=kubernetes.io/basic-auth
oc new-app -f https://raw.githubusercontent.com/3scale/apicast/master/openshift/apicast-template.yml
```
## Features
- Performance: it is fast because it's built on top of [NGINX](https://www.nginx.com/) and uses [LuaJIT](https://luajit.org/).
- Scalability: APIcast is stateless, so it scales horizontally.
- Request transformation: allows to modify the headers, the path and the arguments of a request.
- Rate-limit: can apply limits based on a header, [JWT](https://jwt.io/) claims, the IP of the request and many more.
- Modular and extensible: thanks to the APIcast [policies framework](doc/policies.md).
- Monitoring with [Prometheus](https://prometheus.io/).
- [NGINX instrumentation](https://github.com/open-telemetry/opentelemetry-cpp-contrib) using [OpenTelemetry](https://opentelemetry.io/). Works with [Jaeger](https://www.jaegertracing.io/).
- Can be deployed in [Openshift](https://www.openshift.com/).
- Integrates with IDPs like [Keycloak](https://www.keycloak.org) to provide authentication based on [OIDC](https://openid.net/connect/).
## Development
Using Docker you just need to run:
```shell
make development
```
That will create a Docker container and run bash inside it. The project's source
code will be available in the container and sync'ed with your local `apicast`
directory, so you can edit files in your preferred environment and still be able
to run whatever you need inside the Docker container.
To install the dependencies inside the container run:
```shell
make dependencies
```
To run the [unit tests](/doc/unittests.md) inside the container:
```shell
make busted
```
To run the [integration tests](/doc/integration-tests.md) inside the container:
```shell
make prove
```
To learn about the other available make targets:
```shell
make help
```
APIcast uses:
- [OpenResty](http://openresty.org/en/): a platform that includes NGINX, LuaJIT and Lua modules.
- [busted](https://github.com/Olivine-Labs/busted): for the unit tests.
- [Test::Nginx](http://search.cpan.org/~agent/Test-Nginx/lib/Test/Nginx/Socket.pm): for the integration tests.
More info can be found in the [development](/doc/development.md) specific doc.
## Documentation
- [Configuration parameters](doc/parameters.md)
- [Get started with Lua and OpenResty](doc/policy-development.md)
- [Learn about policies and write your own](doc/policies.md)
- [Available Prometheus metrics](doc/prometheus-metrics.md)
- [Management API](doc/management-api.md)
- [Contribute](.github/CONTRIBUTING.md)
## License
[Apache 2.0](LICENSE)