Skip to content
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.

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

Update examples directory structure #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
71 changes: 71 additions & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,74 @@ web framework which supports decorating functions with macros similarly to the *
- **[viz](https://github.com/viz-rs/viz/tree/main/examples/routing/openapi)**
- **[ntex](https://github.com/leon3s/ntex-rest-api-example)**

## Examples Directory Structure

```
examples/
├── README.md # High-level overview of all examples
├── actix-web/ # Grouping examples by framework/library
│ ├── README.md # Description of Actix-specific examples
│ ├── multiple-api-docs/
│ │ ├── Cargo.toml
│ │ ├── src/
│ │ └── README.md
│ └── scopes-binding/
│ ├── Cargo.toml
│ ├── src/
│ └── README.md
├── axum/
│ ├── README.md
│ ├── fastapi-bindings/
│ │ ├── Cargo.toml
│ │ ├── src/
│ │ └── README.md
│ └── nesting-vendored/
│ ├── Cargo.toml
│ ├── src/
│ ├── Dockerfile
│ └── README.md
├── generic/
│ ├── README.md # For framework-agnostic examples
│ ├── raw-json/
│ │ ├── Cargo.toml
│ │ ├── src/
│ │ └── README.md
│ └── todo/
│ ├── actix/
│ │ ├── Cargo.toml
│ │ ├── src/
│ │ └── README.md
│ ├── axum/
│ │ ├── Cargo.toml
│ │ ├── src/
│ │ └── README.md
│ ├── tide/
│ │ ├── Cargo.toml
│ │ ├── src/
│ │ └── README.md
│ ├── warp/
│ │ ├── Cargo.toml
│ │ ├── src/
│ │ └── README.md
│ └── warp-rapidoc/
│ ├── Cargo.toml
│ ├── src/
│ └── README.md
├── rocket/
│ ├── README.md
│ ├── todo/
│ ├── Cargo.toml
│ ├── src/
│ └── README.md
└── warp/
├── README.md
├── multiple-api-docs/
│ ├── Cargo.toml
│ ├── src/
│ └── README.md
└── redoc-with-file-config/
├── Cargo.toml
├── src/
├── redoc.json
└── README.md
```
23 changes: 0 additions & 23 deletions examples/actix-web-multiple-api-docs-with-scopes/Cargo.toml

This file was deleted.

22 changes: 0 additions & 22 deletions examples/actix-web-multiple-api-docs-with-scopes/README.md

This file was deleted.

71 changes: 0 additions & 71 deletions examples/actix-web-multiple-api-docs-with-scopes/src/main.rs

This file was deleted.

20 changes: 0 additions & 20 deletions examples/actix-web-scopes-binding/Cargo.toml

This file was deleted.

15 changes: 0 additions & 15 deletions examples/actix-web-scopes-binding/README.md

This file was deleted.

55 changes: 0 additions & 55 deletions examples/actix-web-scopes-binding/src/main.rs

This file was deleted.

16 changes: 0 additions & 16 deletions examples/axum-fastapi-bindings/Cargo.toml

This file was deleted.

14 changes: 0 additions & 14 deletions examples/axum-fastapi-bindings/README.md

This file was deleted.

Loading
Loading