apistos-shuttle

Crates.ioapistos-shuttle
lib.rsapistos-shuttle
version0.2.6
sourcesrc
created_at2024-05-15 12:40:55.277547
updated_at2024-06-23 09:05:11.799406
descriptionActix-web OpenAPI v3.0 documentation generator
homepage
repositoryhttps://github.com/netwo-io/apistos
max_upload_size
id1241024
size9,632
Netwo (Oss-Netwo)

documentation

README

Apistos Shuttle   Documentation Latest Version Build Status Deps Status

This crate allows you to run an actix-web server documented with Apistos on Shuttle.

Installation

[dependencies]
#schemars = "0.8"
# sadly we currently rely on a fork to fix multiple flatten for enums, related PR can be found here: https://github.com/GREsau/schemars/pull/264
schemars = { package = "apistos-schemars", version = "0.8" }
apistos = { version = "0.2" }
apistos-shuttle = { version = "0.2" }

Example

use actix_web::web::Json;
use actix_web::Error;

use apistos::api_operation;
use apistos::info::Info;
use apistos::spec::Spec;
use apistos::web::{get, resource, ServiceConfig};
use apistos_shuttle::{ApistosActixWebService, ShuttleApistosActixWeb};

#[api_operation(summary = "Say 'Hello world!'")]
pub(crate) async fn hello_world() -> Result<Json<String>, Error> {
  Ok(Json("Hello world!".to_string()))
}

#[shuttle_runtime::main]
async fn actix_web() -> ShuttleApistosActixWeb<impl FnOnce(&mut ServiceConfig) + Send + Clone + 'static> {
  let spec = Spec {
    info: Info {
      title: "A well documented API running on Shuttle".to_string(),
      description: Some(
        "This is an API documented using Apistos,\na wonderful new tool to document your actix API !".to_string(),
      ),
      ..Default::default()
    },
    ..Default::default()
  };

  let service_config = move |cfg: &mut ServiceConfig| {
    cfg.service(resource("/").route(get().to(hello_world)));
  };

  Ok(ApistosActixWebService {
    spec,
    service_config,
    openapi_path: "/openapi".to_string(),
  })
}

[!IMPORTANT]
Default features are disabled for shuttle-runtime to avoid pulling colored which as a license considered as copyleft by cargo-deny. To implement your own tracing, please visit https://docs.shuttle.rs/configuration/logs

About us

apistos is provided by Netwo.

We use this crate for our internal needs and therefore are committed to its maintenance, however we cannot provide any additional guaranty. Use it at your own risks.

While we won't invest in any feature we don't need, we are open to accept any pull request you might propose.

We are a France based full-remote company operating in the telecom industry. If you are interested in learning more, feel free to visit our career page.

Commit count: 296

cargo fmt