f4bio / hltvapi.rs

hltvapi.rs

table of contents

helpful links

• https://cloudmaker.dev/how-to-create-a-rest-api-in-rust/
• reqwests
• rust-actix-microservice-auth-example

Scripts

bump version

• openapi.yaml: yq e -i '.info.version = "0.2.7"' openapi.yaml
• Cargo.toml: cargo bump patch
• package.json: npm version patch

Documentation

redoc

redoc-cli bundle ./docs/openapi.yaml \
  --template ./docs/template.hbs \
  --output ./static/docs.html

Data

fixtures

see full example (all) and full example (top tier)

news

see full example (all) and specific item

Tests

with newman

see newman's getting started

npx newman run ./docs/hltvapi.postman_collection.json

Environment

App Key

Generate with your favorite tool, for example with apg: $ apg -n 5 -m 40 -t

CI

GitHub Actions

Run locally with act:

act \
  --secret GITHUB_TOKEN=... \
  --secret CODECOV_TOKEN=... \
  --secret AWS_ACCESS_KEY_ID=... \
  --secret AWS_SECRET_ACCESS_KEY=... \
  --secret DIGITALOCEAN_ACCESS_TOKEN=...