use poem::{
http::{header, Method, StatusCode, Uri},
web::cookie::{Cookie, CookieJar, CookieKey},
Endpoint, IntoEndpoint, Request,
};
use poem_openapi::{
param::{Cookie as ParamCookie, CookiePrivate, CookieSigned, Header, Path, Query},
registry::{MetaApi, MetaParamIn, MetaSchema, MetaSchemaRef},
types::Type,
OpenApi, OpenApiService,
};
use serde_json::json;
fn default_i32() -> i32 {
999
}
#[tokio::test]
async fn param_name() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/abc", method = "get")]
async fn test(&self, a: Query<i32>) {
assert_eq!(a.0, 10);
}
}
let meta: MetaApi = Api::meta().remove(0);
assert_eq!(meta.paths[0].operations[0].params[0].name, "a");
let ep = OpenApiService::new(Api, "test", "1.0").into_endpoint();
let resp = ep
.call(
Request::builder()
.method(Method::GET)
.uri(Uri::from_static("/abc?a=10"))
.finish(),
)
.await
.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn query() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(&self, v: Query<i32>) {
assert_eq!(v.0, 10);
}
}
let meta: MetaApi = Api::meta().remove(0);
assert_eq!(
meta.paths[0].operations[0].params[0].in_type,
MetaParamIn::Query
);
assert_eq!(meta.paths[0].operations[0].params[0].name, "v");
let api = OpenApiService::new(Api, "test", "1.0").into_endpoint();
let resp = api
.call(Request::builder().uri(Uri::from_static("/?v=10")).finish())
.await
.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn query_multiple_values() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(&self, v: Query<Vec<i32>>) {
assert_eq!(v.0, vec![10, 20, 30]);
}
}
let meta: MetaApi = Api::meta().remove(0);
assert_eq!(
meta.paths[0].operations[0].params[0].in_type,
MetaParamIn::Query
);
assert_eq!(meta.paths[0].operations[0].params[0].name, "v");
assert_eq!(
meta.paths[0].operations[0].params[0]
.schema
.unwrap_inline()
.ty,
"array"
);
let api = OpenApiService::new(Api, "test", "1.0").into_endpoint();
let resp = api
.call(
Request::builder()
.uri(Uri::from_static("/?v=10&v=20&v=30"))
.finish(),
)
.await
.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn query_default() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(&self, #[oai(default = "default_i32")] v: Query<i32>) {
assert_eq!(v.0, 999);
}
}
let meta: MetaApi = Api::meta().remove(0);
assert_eq!(
meta.paths[0].operations[0].params[0].in_type,
MetaParamIn::Query
);
assert_eq!(meta.paths[0].operations[0].params[0].name, "v");
assert_eq!(
meta.paths[0].operations[0].params[0].schema,
MetaSchemaRef::Inline(Box::new(MetaSchema {
format: Some("int32"),
default: Some(json!(999)),
..i32::schema_ref().unwrap_inline().clone()
}))
);
let api = OpenApiService::new(Api, "test", "1.0").into_endpoint();
let resp = api.call(Request::default()).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn header() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(&self, v: Header<i32>) {
assert_eq!(v.0, 10);
}
}
let api = OpenApiService::new(Api, "test", "1.0").into_endpoint();
let resp = api
.call(Request::builder().header("v", 10).finish())
.await
.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn header_multiple_values() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(&self, v: Header<Vec<i32>>) {
assert_eq!(v.0, vec![10, 20, 30]);
}
}
let api = OpenApiService::new(Api, "test", "1.0").into_endpoint();
let resp = api
.call(
Request::builder()
.header("v", 10)
.header("v", 20)
.header("v", 30)
.finish(),
)
.await
.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn header_default() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(&self, #[oai(default = "default_i32")] v: Header<i32>) {
assert_eq!(v.0, 999);
}
}
let api = OpenApiService::new(Api, "test", "1.0").into_endpoint();
let resp = api.call(Request::default()).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn path() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/k/:v", method = "get")]
async fn test(&self, v: Path<i32>) {
assert_eq!(v.0, 10);
}
}
let api = OpenApiService::new(Api, "test", "1.0").into_endpoint();
let resp = api
.call(Request::builder().uri(Uri::from_static("/k/10")).finish())
.await
.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn cookie() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(&self, v1: ParamCookie<i32>, v2: CookiePrivate<i32>, v3: CookieSigned<i32>) {
assert_eq!(v1.0, 10);
assert_eq!(v2.0, 100);
assert_eq!(v3.0, 1000);
}
}
let cookie_key = CookieKey::generate();
let api = OpenApiService::new(Api, "test", "1.0")
.cookie_key(cookie_key.clone())
.into_endpoint();
let cookie_jar = CookieJar::default();
cookie_jar.add(Cookie::new_with_str("v1", "10"));
cookie_jar
.private_with_key(&cookie_key)
.add(Cookie::new_with_str("v2", "100"));
cookie_jar
.signed_with_key(&cookie_key)
.add(Cookie::new_with_str("v3", "1000"));
let cookie = format!(
"{}; {}; {}",
cookie_jar.get("v1").unwrap(),
cookie_jar.get("v2").unwrap(),
cookie_jar.get("v3").unwrap()
);
let resp = api
.call(Request::builder().header(header::COOKIE, cookie).finish())
.await
.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn cookie_default() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(&self, #[oai(default = "default_i32")] v: ParamCookie<i32>) {
assert_eq!(v.0, 999);
}
}
let api = OpenApiService::new(Api, "test", "1.0").into_endpoint();
let resp = api.call(Request::builder().finish()).await.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn deprecated() {
struct Api;
#[OpenApi]
#[allow(unused_variables)]
impl Api {
#[oai(path = "/a", method = "get")]
async fn a(&self, #[oai(deprecated)] v: Query<i32>) {
todo!()
}
#[oai(path = "/b", method = "get")]
async fn b(&self, v: Query<i32>) {
todo!()
}
}
let meta: MetaApi = Api::meta().remove(0);
assert_eq!(meta.paths[0].path, "/a");
assert!(meta.paths[0].operations[0].params[0].deprecated);
assert_eq!(meta.paths[1].path, "/b");
assert!(!meta.paths[1].operations[0].params[0].deprecated);
}
#[tokio::test]
async fn desc() {
struct Api;
#[OpenApi]
#[allow(unused_variables)]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(
&self,
v: Query<i32>,
) {
todo!()
}
}
let meta: MetaApi = Api::meta().remove(0);
assert_eq!(
meta.paths[0].operations[0].params[0].in_type,
MetaParamIn::Query
);
assert_eq!(meta.paths[0].operations[0].params[0].name, "v");
assert_eq!(
meta.paths[0].operations[0].params[0].description,
Some("ABC")
);
}
#[tokio::test]
async fn default_opt() {
struct Api;
#[OpenApi]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(&self, #[oai(default = "default_value")] v: Query<Option<i32>>) {
assert_eq!(v.0, Some(88));
}
}
fn default_value() -> Option<i32> {
Some(88)
}
let meta: MetaApi = Api::meta().remove(0);
assert_eq!(
meta.paths[0].operations[0].params[0]
.schema
.unwrap_inline()
.default,
Some(json!(88))
);
let api = OpenApiService::new(Api, "test", "1.0").into_endpoint();
let resp = api
.call(Request::builder().uri(Uri::from_static("/")).finish())
.await
.unwrap();
assert_eq!(resp.status(), StatusCode::OK);
}
#[tokio::test]
async fn required_params() {
struct Api;
#[OpenApi]
#[allow(unused_variables)]
impl Api {
#[oai(path = "/", method = "get")]
async fn test(&self, #[oai(default = "default_i32")] a: Query<i32>, b: Query<i32>) {}
}
let meta: MetaApi = Api::meta().remove(0);
assert_eq!(
meta.paths[0].operations[0].params[0].in_type,
MetaParamIn::Query
);
assert_eq!(meta.paths[0].operations[0].params[0].name, "a");
assert_eq!(meta.paths[0].operations[0].params[0].required, false);
assert_eq!(
meta.paths[0].operations[0].params[1].in_type,
MetaParamIn::Query
);
assert_eq!(meta.paths[0].operations[0].params[1].name, "b");
assert_eq!(meta.paths[0].operations[0].params[1].required, true);
}