Clojurians Log v2
ring-swagger
hi there
I'm having some trouble getting the :definitions map to appear in swagger.json
a little context: checking out 2.0 compojure api with spec coercion
for some reason my swagger.json keeps returning empty map definitions: {}
maybe it's because I'm not $ref'ing it anywhere
@nmdrenard the definitions are extracted automatically from endpoints. I’m not sure it can be overridden via the :swagger options. Would you like to write those manually?
What I'm trying to get is the "Models" tab, as can be seen here: https://petstore.swagger.io/
scroll to the bottom
I've got a couple endpoints, validating with spec, both input and output, so that works (really nicely!) But I'd like to have that "Models" thing too. Maybe this is a swagger-ui 3.0 thing?
I think spec-tools doesn’t at the moment support spec references, all models are inlined in the endpoints. Also, this is only visible with the swagger-ui 3.0 (that’s easy to update).
Schema/Ring-swagger supports that, just not spec. There is an PR for it, but looks stalled.
here’s the sample spec-tools generates: https://github.com/metosin/spec-tools#full-example
should be streightforward to collect all the specs with title, ensure they don’t clash, change them to references and put the references under definitions. I personally don’t have time for that, but PR most welcome.
gotcha
link to PR?
It's not critical at all, will just instruct users to do an extra click to the endpoints
and thanks for helping research!
noprob