Asset

Struct Asset 

Source
pub struct Asset;
Expand description

used with swagger openapi eg: I have a swagger.json at path swagger-files/api.json, so I can start a http service for generate swagger

use awesome_operates::embed::{server_dir, EXTRACT_DIR_PATH};
use awesome_operates::swagger::InitSwagger;
use axum::{Router, Extension, routing::get, Json, response::{Response, IntoResponse}};
use tower::ServiceBuilder;
use tower_http::compression::CompressionLayer;
use aide::openapi::OpenApi;
use aide::transform::TransformOpenApi;
use std::sync::Arc;

async fn serve_docs(Extension(api): Extension<Arc<OpenApi>>) -> Response {
    Json(serde_json::json!(*api)).into_response()
}

fn api_docs(api: TransformOpenApi) -> TransformOpenApi {
    api.title("数据采集")
}

#[tokio::test]
async fn server() -> anyhow::Result<()> {
    aide::gen::on_error(|error| {
        println!("{error}")
    });
    aide::gen::extract_schemas(true);
    let mut api = OpenApi::default();

    awesome_operates::extract_all_files!(awesome_operates::embed::Asset);
    InitSwagger::new(EXTRACT_DIR_PATH, "swagger-init.js", "swagger.html", "../api.json").build().await.unwrap();
    let app = Router::new()
        // .api_route("/example", post_with(handlers::example, handlers::example_docs))
        .nest_service("/docs/", server_dir(EXTRACT_DIR_PATH).await.unwrap())
        .route("/api.json", get(serve_docs))
        .finish_api_with(&mut api, api_docs)
        .layer(ServiceBuilder::new()
                .layer(CompressionLayer::new())
                .layer(Extension(Arc::new(api))));

    let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
    Ok(())
 }

finally, you can visit at browser at http://127.0.0.1:3000/docs/ for your swagger

Implementations§

Source§

impl Asset

Source

pub fn get(file_path: &str) -> Option<EmbeddedFile>

Get an embedded file and its metadata.

Source

pub fn iter() -> impl Iterator<Item = Cow<'static, str>>

Iterates over the file paths in the folder.

Trait Implementations§

Source§

impl RustEmbed for Asset

Source§

fn get(file_path: &str) -> Option<EmbeddedFile>

Get an embedded file and its metadata. Read more
Source§

fn iter() -> Filenames

Iterates over the file paths in the folder. Read more

Auto Trait Implementations§

§

impl Freeze for Asset

§

impl RefUnwindSafe for Asset

§

impl Send for Asset

§

impl Sync for Asset

§

impl Unpin for Asset

§

impl UnwindSafe for Asset

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,