29 lines
1.5 KiB
Markdown
29 lines
1.5 KiB
Markdown
|
|
[](https://crates.io/crates/axum-folder-router)
|
|
[](https://docs.rs/axum-folder-router)
|
|
|
|
[](https://www.gnu.org/licenses/agpl-3.0)
|
|
|
|
|
|
# axum-folder-router
|
|
|
|
```folder_router``` is a procedural macro for the Axum web framework that automatically generates router boilerplate based on your file structure.
|
|
It simplifies route organization by using filesystem conventions to define your API routes.
|
|
|
|
## Usage
|
|
|
|
See [the examples](./examples) or [docs.rs](https://docs.rs/axum-folder-router).
|
|
|
|
## License
|
|
|
|
This repository, like all my personal projects, is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later).
|
|
This ensures that modifications to the code remain open source when used in network services.
|
|
Contact me if this doesn't suit your needs.
|
|
|
|
### Contribution
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later) license, shall be licensed as above, without any additional terms or conditions.
|
|
|
|
### Attribution
|
|
|
|
This macro is based on the [build.rs template by @richardanaya](https://github.com/richardanaya/axum-folder-router-htmx)
|