metosin / metosin/compojure-api
Decouple elements of `api`
Nobody has claimed this yet.
- Dominant language
- Clojure
- Stars
- 1.1k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
This issue is created per my Clojurians Slack convo with @ikitommi on 15 February 2017.
When introducing compojure-api to existing compojure projects, one often prefers à la carte access to the functionality provided by api (e.g. the Swagger UI, existing routes, and middleware).
For example:
(root (api {:swagger {:data {:info {:title "api1"}}}} ...)
(api {:swagger {:data {:info {:title "api2"}}}} ...)
my-existing-routes
(resources “/” ...))`
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start from the example in this issue and inspect how api currently provides Swagger UI, existing routes, and middleware. Determine the separate pieces needed for à la carte use in existing Compojure projects, including multiple Swagger configurations. Done means those elements can be used independently without requiring the full api composition.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100