OpenAPI-Spec zu API-Docs zur Verfügung stellen  #1065

 OffenAngenommen
alexwichti
 hat dieses Ticket geöffnet vor 2 Monaten in 💡 Features • 10 Kommentare
alexwichti
 Samstag, 28.06.2025, 12:54

Es wäre toll, wenn die zugehörige OpenAPI-Spezifikation zu eurer API abrufbar wäre, damit man sich damit einfacher einen Client generieren kann.

Alexander Adam
 Samstag, 28.06.2025, 16:00

Hallo,


Ja das ist in Planung, die neue API die kommt hat eine komplette OpenAPI Spezifikation. Diese wird aber erst im Herbst freigegeben wenn das letzte Modul (CRM) fertig ist.


lg

Alex

Oliver
 hinzugefügt API Label Sonntag, 29.06.2025, 18:10
Oliver
 Status geändert in Angenommen Sonntag, 29.06.2025, 18:10
alexwichti
 Freitag, 25.07.2025, 15:08

Auf der neuen Website wird die OpenAPI-Spec bereits beworben:

Gibt es sie jetzt doch schon irgendwo vorab oder doch erst im Herbst? Bei letzterem solltet ihr das vielleicht noch nicht so groß bewerben … 🫣

Alexander Adam
 Montag, 28.07.2025, 06:01

Hi,


Die neue API ist unter https://docs.campai.com/developer zu sehen 😃 Momentan gibts leider noch zwei je nach Funktion aber bald nur noch eine

alexwichti
 Montag, 28.07.2025, 07:13

Ich hoffe, wir reden hier nicht aneinander vorbei 😄

Ich meinte mit diesem Ticket die OpenAPI-Spezifikation (früher Swagger) als JSON- oder YAML-Datei: https://spec.openapis.org/oas/latest.html

Alexander Adam
 Montag, 28.07.2025, 07:20
Alexander Adam
 Montag, 28.07.2025, 07:20

Die API-Doc auf docs.campai.com wird von derselben Swagger OpenAPI json gespeist

alexwichti
 Montag, 28.07.2025, 07:25

Ah, super! 😍 Aber öffentlich verlinkt ist die JSON noch nicht, oder bin ich blind? 😅

Alexander Adam
 Montag, 28.07.2025, 07:26

Nein da wir die in unserer Docs rendern weil wir den original Swagger-Renderer ned so toll fanden 😉


Für was würde man die JSON direkt gebrauchen meinst du?

alexwichti
 Montag, 28.07.2025, 08:05

Damit kann man sich wunderbar API-Clients mit diversen Tools bauen lassen, damit man sich nicht händisch mit den Requests und den Typen rumärgern muss. Wir nutzen das auf Arbeit auch intensiv inkl. unserer Kunden.

Von Swagger selbst z.b. für gefühlt alle Sprachen, aber auch separat jeweils einige je Sprache.

Alexander Adam
 Montag, 28.07.2025, 09:55

Macht sinn dann nehme ich den Link in die Doku auf 😃

2
Je mehr Upvotes, desto höher ist die Wahrscheinlichkeit der Implementierung/Umsetzung
Weitere Aktionen
3 Abonnenten
Abonnieren, um Benachrichtigungen über Änderungen an diesem Ticket in deinem persönlichen Feed zu erhalten