Skip to content

RUST-999 Link web framework examples/documentation in README.md #683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 8, 2022
Merged

RUST-999 Link web framework examples/documentation in README.md #683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a2baaf6
RUST-999 Link web framework examples/documentation in README.md
isabelatkinson Feb 24, 2022
dee8375
add to manual
isabelatkinson Jul 5, 2022
53d2eb4
Update README.md
isabelatkinson Jul 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ For more detailed documentation, see [the manual](https://mongodb.github.io/mong
- [Inserting documents into a collection](#inserting-documents-into-a-collection)
- [Finding documents in a collection](#finding-documents-in-a-collection)
- [Using the sync API](#using-the-sync-api)
- [Web Framework Examples](#web-framework-examples)
- [Platforms](#platforms)
- [Note on connecting to Atlas deployments](#note-on-connecting-to-atlas-deployments)
- [Windows DNS note](#windows-dns-note)
Expand Down Expand Up @@ -235,6 +236,13 @@ for result in cursor {
}
```

## Web Framework Examples
### Actix
The driver can be used easily with the Actix web framework by storing a `Client` in Actix application data. A full example application for using MongoDB with Actix can be found [here](https://github.com/actix/examples/tree/master/databases/mongodb).

### Rocket
The Rocket web framework provides built-in support for MongoDB via the Rust driver. The documentation for the [`rocket_db_pools`](https://api.rocket.rs/v0.5-rc/rocket_db_pools/index.html) crate contains instructions for using MongoDB with your Rocket application.

## Platforms

The driver tests against Linux, MacOS, and Windows in CI.
Expand Down
1 change: 1 addition & 0 deletions manual/src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- [Sessions and Transactions]()
- [Change Streams]()
- [Monitoring]()
- [Web Framework Examples](web_framework_examples.md)

# Development

Expand Down
7 changes: 7 additions & 0 deletions manual/src/web_framework_examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Web Framework Examples

## Actix
The driver can be used easily with the Actix web framework by storing a `Client` in Actix application data. A full example application for using MongoDB with Actix can be found [here](https://github.com/actix/examples/tree/master/databases/mongodb).

## Rocket
The Rocket web framework provides built-in support for MongoDB via the Rust driver. The documentation for the [`rocket_db_pools`](https://api.rocket.rs/v0.5-rc/rocket_db_pools/index.html) crate contains instructions for using MongoDB with your Rocket application.