Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/duffn/grape-api-boilerplate
A full-featured, production ready, and easy to understand API boilerplate for the Grape framework.
https://github.com/duffn/grape-api-boilerplate
api boilerplate grape grape-api hacktoberfest rack ruby
Last synced: 2 months ago
JSON representation
A full-featured, production ready, and easy to understand API boilerplate for the Grape framework.
- Host: GitHub
- URL: https://github.com/duffn/grape-api-boilerplate
- Owner: duffn
- License: mit
- Created: 2022-06-20T16:02:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T12:30:21.000Z (7 months ago)
- Last Synced: 2024-05-29T04:02:22.747Z (7 months ago)
- Topics: api, boilerplate, grape, grape-api, hacktoberfest, rack, ruby
- Language: Ruby
- Homepage:
- Size: 2.21 MB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# grape-api-boilerplate
[](https://github.com/duffn/grape-api-boilerplate/actions/workflows/test.yml) [](https://github.com/duffn/grape-api-boilerplate/actions/workflows/rubocop.yml) [](https://codecov.io/gh/duffn/grape-api-boilerplat)
A full-featured, production ready, and easy to understand API boilerplate for
the [Grape framework](https://github.com/ruby-grape/grape).
## Features
- Local development with [Docker](https://www.docker.com/) and Docker Compose.
- Automatic Puma reloading locally with [`guard-puma`](https://github.com/jc00ke/guard-puma).
- ActiveRecord with [`otr-activerecord`](https://github.com/jhollinger/otr-activerecord).
- Swagger API documentation with [`grape-swagger`](https://github.com/ruby-grape/grape-swagger).
- User authentication with [`bcrypt`](https://github.com/bcrypt-ruby/bcrypt-ruby)
using [`jwt`](https://github.com/jwt/ruby-jwt).
- Model pagination with [`api-pagination`](https://github.com/davidcelis/api-pagination).
- Standard security headers with [`secure_headers`](https://github.com/github/secure_headers).
- Monitoring and alerting with [Sentry](https://sentry.io) and[Prometheus](https://prometheus.io).
- Comprehensive [RSpec](https://rspec.info/) test suite and code coverage.
## Running
- Generate a key pair for local JWT authentication.
```
cd grape-api-boilerplate/config/jwt
ssh-keygen -t rsa -b 4096 -m PEM -f jwtRS256.key
openssl rsa -in jwtRS256.key -pubout -outform PEM -out jwtRS256.key.pub
```
- Build and run with Docker Compose.
```
docker compose up --build
```
- Setup and seed the database.
```
docker compose exec app bundle exec rake db:setup
```
- Visit your API at http://localhost:3000
## Creating a user
- Run the create users Rake task.
```
docker compose run --rm app bundle exec rake users:create
```
- Enter your desired email, username, and password.
## Tests
- Run linting and tests.
```
docker compose run --rm -e RACK_ENV=test app bundle exec rake
```
## API documentation
When running locally, you can visit http://localhost:3000/public/swagger/index.html to view your Swagger API
documentation.
## Production
### Sentry
You can enable [Sentry](https://sentry.io/) for your API by setting `sentry.enabled` in your settings file(s).
- Update the setting in `app/settings/.yml`.
```yaml
sentry:
enabled: true
```
- Add your Sentry DSN to a `SENTRY_DSN` environment variable.
- See the [Sentry Rack guide](https://docs.sentry.io/platforms/ruby/guides/rack/) for more.
### Prometheus
You can enable [Prometheus](https://prometheus.io/) metrics for your API by setting `prometheus.enabled` in your production settings file.
- Update the setting in `app/settings/production.yml`.
```yaml
prometheus:
enabled: true
```
- The default middleware will provide some basic metrics out of the box. See the [Ruby Prometheus client library documentation](https://github.com/prometheus/client_ruby) for advanced usage.
_Note_: Prometheus metrics should not be exposed publicly! Please ensure you know what you're doing before enabling this feature in your environment.
### Docker
Build a production ready image with the [`Dockerfile`](Dockerfile) and deploy to your favorite platform.
```
docker build -t grape-api-boilerplate:latest .
```
## Contributing
Contributions are welcome! See [CONTRIBUTING](CONTRIBUTING.md).
## License
MIT License. See [LICENSE](LICENSE) for details.