Compojure-api roadmap about compojure-api

[ikitommi]

did a spike to refactor internals for 5 & 8. Stuff found in here:
https://github.com/metosin/compojure-api/compare/context-star

notable changes:

• breaking: meta-data handlers collects parameters in 2.0 format, meta/src-coerce! removed in favour of meta/src-coerce-param!. Will break client restructuring, but those should be easy to fix (need migration guide).
• context* allows setting the meta-datas to mid-routes. Route-peeler accumulates all meta-data to endpoints (via deep-merge). does not currently rewrite the code itself, so works in the route-peeling phase for the swagger datas.
• separate pipeline to accumulate the runtime meta-datas to endpoint via lexically scoped meta/+compojure-api-meta+. This would not work over defroutes*.
• TODO: figure out how to combine the two accumulations (route-peeling time & runtime). Will do some extra spiking on this. Will not push anything into master before things clear out. Would work ok if we approve that parameter validations can't inherit from mid-routes to endpoints.

    (context* "/context/:kikka" []
      :summary "summary inherited from context" ; works ok
      :path-params [kikka :- s/Str] ; currently enforced here 
      :query-params [kukka :- s/Str] ; currently enforced here too
      (GET* "/api" []
        ; does not generate any code for parameter validation as meta-data is passed in at runtime (not at compile-time)
        (ok {:kikka kikka
             :kukka kukka})))

[ikitommi]

... context* seems to work ok'ish. Does not cumulate lists & sets. Could...

(fact "accumulation in context*"
  (let [metas (atom nil)]
    (defapi api
      (swaggered +name+
        (context* "/:id" []
          :path-params [id :- String]
          :tags [:api]
          :summary "jeah"
          (GET* "/:di/ping" []
            :tags [:ipa]
            :path-params [di :- String]
            :query-params [foo :- s/Int]
            (reset! metas +compojure-api-meta+)
            (ok [id di foo])))))

    (fact "all but lists & sequences get accumulated"
      (let [[status body] (get* api "/kikka/kukka/ping" {:foo 123})]
        status => 200
        body => ["kikka" "kukka" 123]
        @metas => {:parameters {:path {:id String
                                       :di String
                                       s/Keyword s/Any}
                                :query {:foo s/Int
                                        s/Keyword s/Any}}
                   :summary "jeah"
                   :tags #{:ipa}}))))

[ikitommi]

https://github.com/metosin/compojure-api/tree/swagger2routes