Utoipauto

https://docs.rs/utoipauto/0.2.0
Admin
Utoipauto is a Rust macro library that automatically discovers functions with the #[utoipa]...
Tokens:1,561
Snippets:23
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Auto-discovery of API Paths with utoipauto Macro

Source: https://docs.rs/utoipauto/0.2.0/src/utoipauto/lib.rs.html

Use the `#[utoipauto]` macro to automatically discover and document API paths from a specified directory. This is useful for generating OpenAPI documentation for your entire crate or specific modules.

```rust
1#![allow(dead_code)] // This code is used in the tests
2
3pub use utoipauto_macro::*
5
6#[cfg(test)]
7mod test {
    use utoipa::OpenApi;
    use utoipauto_macro::utoipauto;

    #[utoipa::path(post, path = "/route1")]
    pub fn route1() {}

    #[utoipa::path(post, path = "/route2")]
    pub fn route2() {}

    #[utoipa::path(post, path = "/route3")]
    pub fn route3() {}

    /// Discover from the crate root auto
    #[utoipauto(paths = "./utoipauto/src")]
    #[derive(OpenApi)]
    #[openapi(info(title = "Percentage API", version = "1.0.0"))]
    pub struct CrateAutoApiDocs {}

    #[test]
    fn test_crate_auto_import_path() {
        assert_eq!(CrateAutoApiDocs::openapi().paths.paths.len(), 3)
    }
}
```

--------------------------------

### Automatic API Path Discovery

Source: https://docs.rs/utoipauto/0.2.0/src/utoipauto/lib.rs.html

The `utoipauto` macro can be used to automatically discover API paths from a given directory. This is useful for generating OpenAPI documentation for your project without manually defining each path.

```APIDOC
## Discover from the crate root auto

### Description
This attribute automatically discovers API paths from the specified directory and includes them in the OpenAPI documentation.

### Method
Macro attribute

### Endpoint
N/A (Macro usage)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
#[utoipauto(paths = "./utoipauto/src")]
#[derive(OpenApi)]
#[openapi(info(title = "Percentage API", version = "1.0.0"))]
pub struct CrateAutoApiDocs {}
```

### Response
#### Success Response (200)
N/A (Macro usage)

#### Response Example
N/A (Macro usage)
```

--------------------------------

### Apply utoipauto Macro

Source: https://docs.rs/utoipauto/0.2.0/utoipauto/attr.utoipauto.html

Apply this macro to automatically discover API endpoints. It requires functions with #[utoipa] and structs deriving ToSchema and ToResponse.

```rust
#[utoipauto]
```

--------------------------------

### Manually Defined API Paths

Source: https://docs.rs/utoipauto/0.2.0/src/utoipauto/lib.rs.html

Individual API paths can also be defined manually using the `utoipa::path` attribute. This allows for fine-grained control over specific routes.

```APIDOC
## Route 1

### Description
Defines a POST route at `/route1`.

### Method
POST

### Endpoint
/route1

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
#[utoipa::path(post, path = "/route1")]
pub fn route1() {}
```

### Response
#### Success Response (200)
N/A (Function signature only)

#### Response Example
N/A
```

```APIDOC
## Route 2

### Description
Defines a POST route at `/route2`.

### Method
POST

### Endpoint
/route2

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
#[utoipa::path(post, path = "/route2")]
pub fn route2() {}
```

### Response
#### Success Response (200)
N/A (Function signature only)

#### Response Example
N/A
```

```APIDOC
## Route 3

### Description
Defines a POST route at `/route3`.

### Method
POST

### Endpoint
/route3

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```rust
#[utoipa::path(post, path = "/route3")]
pub fn route3() {}
```

### Response
#### Success Response (200)
N/A (Function signature only)

#### Response Example
N/A
```

--------------------------------

### Ignore Function from Auto Discovery

Source: https://docs.rs/utoipauto/0.2.0/utoipauto/attr.utoipa_ignore.html

Apply this attribute to a function to prevent it from being included in the automatically generated OpenAPI documentation.

```rust
#[utoipa_ignore]
fn my_function() {}
```

--------------------------------

### test_handler Attribute Macro

Source: https://docs.rs/utoipauto/0.2.0/utoipauto/attr.test_handler.html

This macro is intended for testing custom function attributes. It does not perform any specific actions.

```rust
#[test_handler]
```
Tokens:
Raw