metosin / metosin/compojure-api

Group versioned API

Open
#440 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Library Version(s)

I am using metosin/ring-swagger "0.26.0" and metosin/ring-swagger-ui "3.9.0".

Problem

I am trying to use swagger for my versioned APIs, any idea what json configuration i will have to pass to swagger-json function to group API in a versioned manner as shown in image. I went through documentation but couldn't find any.

image

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

Start with the swagger-json function and the documentation for ring-swagger 0.26.0 and ring-swagger-ui 3.9.0, then compare the requested version grouping with the linked example image. Done means identifying the supported JSON configuration, or documenting that this grouping is not supported and what limitation applies.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure, openapi
Domain
api, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.