Api documentation as json or interactively?
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- HTML
- Sterne
- 26
- Forks
- 8
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
I checked out the api documentation and couldn't find a way to get the modules and methods in a machine readable way. However typedoc states that you can generate json from the comments.
Could we add json somehow, maybe for something like
https://plugins-doc.logseq.com/logseq/baseInfo
it could just be:
https://plugins-doc.logseq.com/logseq/baseInfo.json
An alternative could be something like swagger, which is for OpenApi-documented RESTful apis only. But maybe there exists something comparable for typedoc?!
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der verlinkten API-Dokumentation und der Dokumentation von TypeDoc zur JSON-Generierung; vergleiche den vorgeschlagenen .json-Endpunkt mit der Swagger/OpenAPI-Alternative. Als abgeschlossen gilt ein dokumentierter, abgestimmter Ansatz, um Module und Methoden in einer maschinenlesbaren Form bereitzustellen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- json, openapi
- Bereich
- api, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100