logseq / logseq/plugins

Api documentation as json or interactively?

Ouverte
#11 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
HTML
Étoiles
26
Forks
8
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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?!

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la documentation de l’API liée et par la documentation de TypeDoc sur la génération de JSON ; comparez le point de terminaison .json proposé avec l’alternative Swagger/OpenAPI. Le travail sera considéré comme terminé lorsqu’une approche documentée et approuvée pour exposer les modules et les méthodes sous une forme lisible par une machine sera définie.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
json, openapi
Domaine
api, documentation
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.