Struct OpenApiConfig 

pub struct OpenApiConfig {
    pub enabled: bool,
    pub title: String,
    pub version: String,
    pub description: Option<String>,
    pub openapi_path: String,
    pub servers: Vec<(String, Option<String>)>,
    pub tags: Vec<(String, Option<String>)>,
}

Configuration for OpenAPI documentation generation.

When enabled, the application will automatically generate an OpenAPI 3.1 specification and serve it at the configured endpoint (default /openapi.json).

Example

use fastapi_core::app::{App, OpenApiConfig};

let app = App::builder()
    .openapi(OpenApiConfig::new()
        .title("My API")
        .version("1.0.0")
        .description("A sample API"))
    .build();

Fields

enabled: bool

Whether OpenAPI documentation is enabled.

title: String

API title for the OpenAPI spec.

version: String

API version for the OpenAPI spec.

description: Option<String>

API description.

openapi_path: String

Path to serve the OpenAPI JSON (default: “/openapi.json”).

servers: Vec<(String, Option<String>)>

Servers to include in the spec.

tags: Vec<(String, Option<String>)>

Tags for organizing operations.

Implementations

impl OpenApiConfig

pub fn new() -> Self

Create a new OpenAPI configuration with defaults.

pub fn title(self, title: impl Into<String>) -> Self

Set the API title.

pub fn version(self, version: impl Into<String>) -> Self

Set the API version.

pub fn description(self, description: impl Into<String>) -> Self

Set the API description.

pub fn path(self, path: impl Into<String>) -> Self

Set the path for the OpenAPI JSON endpoint.

pub fn server(self, url: impl Into<String>, description: Option<String>) -> Self

Add a server to the spec.

pub fn tag(self, name: impl Into<String>, description: Option<String>) -> Self

Add a tag to the spec.

pub fn disable(self) -> Self

Disable OpenAPI documentation.

Trait Implementations

impl Clone for OpenApiConfig

fn clone(&self) -> OpenApiConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenApiConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenApiConfig

fn default() -> Self

Returns the “default value” for a type.