metosin / metosin/compojure-api
OpenAPI?
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)
```clojure
[metosin/compojure-api "2.0.0-alpha31"]
[metosin/spec-tools "0.10.4"]
```
## Problem
I can't seem to find a standard way to generate OpenAPI specification from my `api`. I have the swagger spec and swagger UI working just fine (and it rocks!). But a team I'm working with needs OpenAPI specs (and possibly also UI).
It'd be cool if the `:swagger` etc. could be replaced by `:openapi` in this snippet of a snippet:
```clojure
(api
{:swagger
{:ui "/"
:spec "/swagger.json"
:data {...
```
Do you have an example project where you've implemented this, or can you give me some hints on how - if possible - to achieve this?
Thanks.
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 by tracing the existing :swagger configuration in the api snippet and how the current Swagger specification and UI are generated. Determine the scope of OpenAPI support and whether an example project is needed; done would require an agreed implementation or documented approach, with any relevant generation and UI behavior covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure, openapi
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100