Api documentation as json or interactively?
Nessuno ha ancora preso questa issue.
- Lingua principale
- HTML
- Stelle
- 26
- Fork
- 8
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
I checked out the [api documentation](https://plugins-doc.logseq.com/) and couldn't find a way to get the modules and methods in a machine readable way. However [typedoc](https://typedoc.org/) 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](https://swagger.io/), which is for OpenApi-documented RESTful apis only. But maybe there exists something comparable for typedoc?!
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla documentazione dell’API collegata e dalla documentazione di TypeDoc sulla generazione di JSON; confronta l’endpoint .json proposto con l’alternativa Swagger/OpenAPI. Il lavoro sarà considerato completato quando sarà definito un approccio documentato e concordato per esporre moduli e metodi in una forma leggibile dalle macchine.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- json, openapi
- Ambito
- api, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100