mirror of
https://github.com/fafhrd91/actix-web
synced 2024-11-24 08:22:59 +01:00
docs(lib): Add a note about getting started with the API docs
Adds some initial pointers for newcomers to the documentation that direct them at some of the most commonly used API types. I based these links on what *I* usually end up looking at when I open the actix_web docs.
This commit is contained in:
parent
b2a43a3c8d
commit
9fb0498437
23
src/lib.rs
23
src/lib.rs
@ -20,13 +20,31 @@
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! ## Documentation
|
||||
//! ## Documentation & community resources
|
||||
//!
|
||||
//! Besides the API documentation (which you are currently looking
|
||||
//! at!), several other resources are available:
|
||||
//!
|
||||
//! * [User Guide](http://actix.github.io/actix-web/guide/)
|
||||
//! * [Chat on gitter](https://gitter.im/actix/actix)
|
||||
//! * [GitHub repository](https://github.com/actix/actix-web)
|
||||
//! * [Cargo package](https://crates.io/crates/actix-web)
|
||||
//! * Supported Rust version: 1.21 or later
|
||||
//!
|
||||
//! To get started navigating the API documentation you may want to
|
||||
//! consider looking at the following pages:
|
||||
//!
|
||||
//! * [App](struct.App.html): This struct represents an actix-web
|
||||
//! application and is used to configure routes and other common
|
||||
//! settings.
|
||||
//!
|
||||
//! * [HttpServer](server/struct.HttpServer.html): This struct
|
||||
//! represents an HTTP server instance and is used to instantiate and
|
||||
//! configure servers.
|
||||
//!
|
||||
//! * [HttpRequest](struct.HttpRequest.html) and
|
||||
//! [HttpResponse](struct.HttpResponse.html): These structs
|
||||
//! represent HTTP requests and responses and expose various methods
|
||||
//! for inspecting, creating and otherwise utilising them.
|
||||
//!
|
||||
//! ## Features
|
||||
//!
|
||||
@ -41,6 +59,7 @@
|
||||
//! * SSL support with OpenSSL or `native-tls`
|
||||
//! * Middlewares (`Logger`, `Session`, `CORS`, `CSRF`, `DefaultHeaders`)
|
||||
//! * Built on top of [Actix actor framework](https://github.com/actix/actix)
|
||||
//! * Supported Rust version: 1.21 or later
|
||||
|
||||
#![cfg_attr(actix_nightly, feature(
|
||||
specialization, // for impl ErrorResponse for std::error::Error
|
||||
|
Loading…
Reference in New Issue
Block a user