Difference when using (defapi ...) and (api ...)

[dpassen]

When using compojure-api 0.22.2 (and 0.22.1), I expect no difference between the following applications:

(ns foobar.handler
  (:require [compojure.api.sweet :refer :all]
            [compojure.route :as route]
            [ring.middleware.defaults :refer [wrap-defaults site-defaults]]
            [schema.core :refer [defschema] :as schema])
  (:import [clojure.lang Keyword]))

(defschema Foo
  [schema/Keyword])

(defschema Bar
  [Keyword])

(defapi app-routes
  (swagger-docs {:info {:title "FooBar"}})
  (GET* "/foo" []
        :return Foo
        (constantly [:foo :is :great]))
  (GET* "/bar" []
        :return Bar
        (constantly [:bar :is :better]))
  (route/not-found "Not Found"))

(def app
  (wrap-defaults app-routes site-defaults))

and

(ns foobar.handler
  (:require [compojure.api.sweet :refer :all]
            [compojure.route :as route]
            [ring.middleware.defaults :refer [wrap-defaults site-defaults]]
            [schema.core :refer [defschema] :as schema])
  (:import [clojure.lang Keyword]))

(defschema Foo
  [schema/Keyword])

(defschema Bar
  [Keyword])

(defn app-routes
  []
  (api
   (swagger-docs {:info {:title "FooBar"}})
   (GET* "/foo" []
         :return Foo
         (constantly [:foo :is :great]))
   (GET* "/bar" []
         :return Bar
         (constantly [:bar :is :better]))
   (route/not-found "Not Found")))

(def app
  (wrap-defaults (app-routes) site-defaults))

However, when running them and inspecting the generated swagger.json, the second version, not using defapi, contains this definition for Foo:

"schema": {
    "type": "array",
    "items": null
},
"description": ""

when items should be of type "string".

For now, our workaround is to use clojure.lang.Keyword which works within defapi or within a plain api call.

[ikitommi]

That's strange. They should produce the same outputs. Would you have time to create a minimalistic sample project with lein new compojure-api something with the codes?

Btw, both schemas are "primitive arrays", which is, for some reason, not implemented by ring-swagger. There is a ongoing PR to fix that.

metosin/ring-swagger#56

[dpassen]

Sure. Here is a small project generated from the compojure-api template.

The defapi branch works as expected.
The api-within-fn branch shows the issue.

[dparis]

Just bumped into this myself. Spent a frustrating amount of time trying to figure out why things weren't working like the example documentation until I tried using (defapi ...) instead of (defn foo [] (api ...)).

For example, the app would throw an exception about a missing ctor when using a predicate schema to validate :body parameters when using api but it seems to work fine (or at least it compiles without exception) when using defapi. I was also seeing some validation errors originating in ring-swagger when passing the {:coercion ...} options map to api.

If I have time in the next few days, I'll try to put together a more thorough test case.

[ikitommi]

sorry for not having time on this. We finally got the Schema 1.0+ support and Kekkonen is out, will check this later today/tomorrow.

[ikitommi]

Ok, have a failing test for this in https://github.com/metosin/compojure-api/blob/defapi-vs-api-schemas/test/compojure/api/integration_test.clj#L1211-L1212. Have to figure out what's happening. defapi works as expected.

[dpassen]

Thanks

[ikitommi]

Investigated this, and bumped into Clojure compiler oddities. First one is fixed in 1.8.0-alpha2. Will have to dig deeper with the other one, but have a idea on how to fix this (on the ring-swagger side).

[ikitommi]

should be fixed now in [0.24.1-SNAPSHOT]

[ikitommi]

0.24.1 released.