compojure-api spec响应机构强制

时间:2017-10-12 05:48:46

标签: clojure compojure-api

我正在试图弄清楚如何使用compojure-api和spec进行自定义强制。通过阅读文档和代码,我能够对输入(正文)进行强制,但我无法对响应主体进行强制。

具体来说,我有一个自定义类型,一个时间戳,在我的应用程序中表示为long,但对于我想要使用的Web API并返回ISO时间戳(不,我不想在内部使用Joda)。

以下是我对输入强制有效的方法,但我无法正确强制反应。

(ns foo
  (:require [clj-time.core :as t]
            [clj-time.coerce :as t.c]
            [spec-tools.conform :as conform]
            [spec-tools.core :as st]))


(def timestamp (st/create-spec
            {:spec pos-int?
             :form `pos-int?
             :json-schema/default "2017-10-12T05:04:57.585Z"
             :type :timestamp}))

(defn json-timestamp->long [_ val]
  (t.c/to-long val))

(def custom-json-conforming
  (st/type-conforming
   (merge
    conform/json-type-conforming
    {:timestamp json-timestamp->long}
    conform/strip-extra-keys-type-conforming)))

(def custom-coercion
  (->  compojure.api.coercion.spec/default-options
       (assoc-in [:body :formats "application/json"] custom-json-
conforming)
       compojure.api.coercion.spec/create-coercion))

;; how do I use this for the response coercion?
(defn timestamp->json-string [_ val]
  (t.c/to-string val))
;; I've tried the following but it doesn't work:
#_(def custom-coercion
  (->  compojure.api.coercion.spec/default-options
       (assoc-in [:body :formats "application/json"] custom-json-
conforming)
       (assoc-in [:response :formats "application/json"]
                 (st/type-conforming
                  {:timestamp timestamp->json-string}))
       compojure.api.coercion.spec/create-coercion))

1 个答案:

答案 0 :(得分:2)

问题是Spec Conforming是一个单向转换管道:

s/conform(因为那个st/conform)会对结果进行转换和验证。您的响应强制首先将整数转换为日期字符串,然后将其与原始规范谓词pos-int?进行验证,然后失败。

要支持双向转换,您需要将最终结果定义为可能的格式之一:例如将您的谓词更改为类似#(or (pos-int? %) (string? %))的内容,它应该有效。

或者您可以有两个不同的规范记录,一个用于输入(timestamp-longpos-int?谓词),另一个用于输出(timestamp-stringstring?谓词)。但是需要记住使用正确的请求&响应。

CLJ-2251可能有帮助,如果有额外的:transform模式(尚未在问题中写入),这将符合要求而不验证最终结果。

通常,返回转换由格式编码器完成,但它们通常在值类型上进行调度。例如,Cheshire只看到一个Long,并且不知道它应该写成日期字符串。

也许#clojure-spec懈怠的人可以提供帮助。还想知道如何使用规范构建这种双向转换。