129 lines
3.9 KiB
Rust
129 lines
3.9 KiB
Rust
/*
|
|
* Copyright (C) 2022 Aravinth Manivannan <realaravinth@batsense.net>
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
use std::borrow::Cow;
|
|
|
|
use actix_web::body::BoxBody;
|
|
use actix_web::{http::header, web, HttpResponse, Responder};
|
|
use mime_guess::from_path;
|
|
use rust_embed::RustEmbed;
|
|
|
|
use crate::CACHE_AGE;
|
|
|
|
pub const DOCS: routes::Docs = routes::Docs::new();
|
|
|
|
pub mod routes {
|
|
pub struct Docs {
|
|
pub home: &'static str,
|
|
pub spec: &'static str,
|
|
pub assets: &'static str,
|
|
}
|
|
|
|
impl Docs {
|
|
pub const fn new() -> Self {
|
|
Docs {
|
|
home: "/docs/openapi",
|
|
spec: "/docs/openapi/openapi.yml",
|
|
assets: "/docs/openapi/{_:.*}",
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
pub fn services(cfg: &mut web::ServiceConfig) {
|
|
cfg.service(index).service(spec).service(dist);
|
|
}
|
|
|
|
#[derive(RustEmbed)]
|
|
#[folder = "docs/openapi/"]
|
|
struct Asset;
|
|
|
|
pub fn handle_embedded_file(path: &str) -> HttpResponse {
|
|
match Asset::get(path) {
|
|
Some(content) => {
|
|
let body: BoxBody = match content.data {
|
|
Cow::Borrowed(bytes) => BoxBody::new(bytes),
|
|
Cow::Owned(bytes) => BoxBody::new(bytes),
|
|
};
|
|
|
|
HttpResponse::Ok()
|
|
.insert_header(header::CacheControl(vec![
|
|
header::CacheDirective::Public,
|
|
header::CacheDirective::Extension("immutable".into(), None),
|
|
header::CacheDirective::MaxAge(CACHE_AGE),
|
|
]))
|
|
.content_type(from_path(path).first_or_octet_stream().as_ref())
|
|
.body(body)
|
|
}
|
|
None => HttpResponse::NotFound().body("404 Not Found"),
|
|
}
|
|
}
|
|
|
|
#[actix_web_codegen_const_routes::get(path = "DOCS.assets")]
|
|
async fn dist(path: web::Path<String>) -> impl Responder {
|
|
handle_embedded_file(&path)
|
|
}
|
|
const OPEN_API_SPEC: &str = include_str!("../docs/openapi/openapi.yml");
|
|
|
|
#[actix_web_codegen_const_routes::get(path = "DOCS.spec")]
|
|
async fn spec() -> HttpResponse {
|
|
HttpResponse::Ok()
|
|
.content_type("text/yaml")
|
|
.body(OPEN_API_SPEC)
|
|
}
|
|
|
|
#[actix_web_codegen_const_routes::get(path = "DOCS.home")]
|
|
async fn index() -> HttpResponse {
|
|
handle_embedded_file("index.html")
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use actix_web::http::StatusCode;
|
|
use actix_web::test;
|
|
|
|
use super::*;
|
|
use crate::*;
|
|
|
|
#[actix_rt::test]
|
|
async fn docs_works() {
|
|
const FILE: &str = "openapi.yml";
|
|
|
|
let app = test::init_service(
|
|
App::new()
|
|
.wrap(actix_web::middleware::NormalizePath::new(
|
|
actix_web::middleware::TrailingSlash::Trim,
|
|
))
|
|
.configure(services),
|
|
)
|
|
.await;
|
|
|
|
let resp =
|
|
test::call_service(&app, test::TestRequest::get().uri(DOCS.home).to_request()).await;
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
let resp =
|
|
test::call_service(&app, test::TestRequest::get().uri(DOCS.spec).to_request()).await;
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
|
|
let uri = format!("{}/{}", DOCS.home, "favicon-32x32.png");
|
|
println!("{uri}");
|
|
|
|
let resp = test::call_service(&app, test::TestRequest::get().uri(&uri).to_request()).await;
|
|
assert_eq!(resp.status(), StatusCode::OK);
|
|
}
|
|
}
|