docs: Protecting and Rate Limiting Rust Actix Web API Template

[djnovin]

What does this PR do?

In this pull request, I've integrated Unkey to provide route protection and rate limiting for the application for hackathon. This is a side quest to make a template using a framework.

• API Key Verification: Added middleware to verify API keys using Unkey. Only requests with valid API keys in the Authorization header (Bearer token) are allowed to access protected routes.
• Rate Limiting: Implemented rate limiting using the Unkey rate limits API. Each request is checked against the defined rate limit.

Fixes #2292

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

git clone https://github.com/djnovin/unkey-rust-actix

cargo run

curl http://localhost:3000/api/v1/protected -H "Authorization: Bearer <YOUR_API_KEY>"

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

[changeset-bot]

⚠️ No Changeset found

Latest commit: cc7ee32

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

@djnovin is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 10, 2024 2:56am

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates the documentation for creating templates using Unkey across various frameworks or languages to build APIs. It introduces a new side quest entry that encourages participants to document their setup experiences and provide feedback, with a points system for contributions. Additionally, it specifies submission requirements, including open-source licensing and a README.md file, while expanding the list of existing submissions to include a new project by Novin Noori related to Rust and Actix Web.

Changes

File Path	Change Summary
oss.gg/7_create_a_template.md	- Added new entry for a side quest on creating templates with Unkey.
	- Specified requirements for submissions including licensing and README.md.
	- Expanded existing submissions to include Novin Noori's project on Rust + Actix Web API with Unkey.

Possibly related PRs

• feat: Unkey-flask template [SIDE QUEST] #2174: This PR adds a new entry for a Flask template using Unkey, which is directly related to the main PR's focus on creating templates for various frameworks.
• chore: Unkey PDF Viewer template [SIDE QUEST] #2191: This PR introduces additional requirements for creating templates with Unkey and includes a new entry for a project that also utilizes Unkey, aligning with the main PR's updates.
• chore: Rust + Axum template [SIDE QUEST] #2237: This PR adds a new entry for a Rust + Axum API project using Unkey, which is relevant to the main PR's updates on submissions related to Unkey templates.
• feat: Create a template with Unkey #2272: This PR focuses on creating templates for using Unkey, which directly connects to the main PR's objective of expanding the documentation for template submissions.

Suggested labels

🕹️ oss.gg, :joystick: 750 points, hacktoberfest

Suggested reviewers

• mcstepp
• chronark
• MichaelUnkey
• perkinsjr

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b68e117 and cc7ee32.

📒 Files selected for processing (1)

• oss.gg/7_create_a_template.md (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

oss.gg/7_create_a_template.md (1)

38-39: New entry looks good, but let's verify a few things.

The new entry for Novin Noori's project follows the correct format and appears to meet the side quest requirements. However, let's verify a few points:

1. The project uses Rust + Actix Web, which doesn't seem to be a duplicate of existing entries.
2. The link leads to a GitHub repository, which is in line with the requirements.

To ensure full compliance with the side quest requirements, please verify:

1. The repository is open source and uses the MIT license.
2. There's a README.md file with a quickstart guide.

Let's run a script to check these requirements:

This script will help us confirm that the repository meets all the specified requirements.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[CLAassistant]

All committers have signed the CLA.

[oss-gg]

Awarding djnovin: 750 points 🕹️ Well done! Check out your new contribution on oss.gg/djnovin