OpenAPI?

Offen
  • Stimmt etwas nicht?
#447 5 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Feature
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
clojure, openapi
Bereich
api, backend-api-design

Rechercherichtung

Beginne damit, die bestehende Konfiguration :swagger im api snippet nachzuverfolgen und zu untersuchen, wie die aktuelle Swagger-Spezifikation und UI generiert werden. Bestimme den Umfang der OpenAPI-Unterstützung und ob ein Beispielprojekt erforderlich ist; als abgeschlossen gilt dies bei einer vereinbarten Implementierung oder einem dokumentierten Ansatz, wobei das relevante Verhalten bei der Generierung und der UI abgedeckt sein muss.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Library Version(s)

[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:

(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.

Vorherrschende Sprache
Clojure
Sterne
1.1k
Forks
144
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus metosin/compojure-api

Alle Issues in metosin/compojure-api

Ähnliche Issues

Weitere Issues zu Clojure

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.