metosin / metosin/compojure-api

:spec path auto-resolution doesn’t work under context

Open
#290 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Clojure
Stars
1.1k
Forks
146
PR merge metrics
No merged PRs in 30d

Description

using swagger-routes under context fails to produce the correct path for swagger.json

(ring/context "/docs" []
    (docs/swagger-routes
     {:ui "/"
      :spec "/swagger.json"
      :data {:info {:title "Bla Bla"
                    :description "Bla Bla"}}}))

produces Can't read swagger JSON from http://localhost:3000/swagger.json

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the example using ring/context and docs/swagger-routes, then trace how the swagger route resolves the spec path under the /docs context. Done means the generated request looks for swagger.json at the context-aware path instead of http://localhost:3000/swagger.json.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure, openapi
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.